OSharp框架快速入门指南:从零开始构建企业级应用
前言
OSharp框架是一个基于.NET Core的企业级快速开发框架,采用前后端分离架构,为开发者提供了一套完整的解决方案。本文将详细介绍如何从零开始搭建一个基于OSharp框架的项目,涵盖开发环境配置、项目初始化到前后端项目启动的全过程。
开发环境准备
后端开发环境
.NET Core SDK安装
OSharp框架基于.NET 6.0开发,因此需要安装对应版本的SDK:
- 访问微软官方下载页面获取最新稳定版SDK
- 选择与您操作系统匹配的安装包
- 安装完成后,在命令行执行
dotnet --info
验证安装
开发工具选择
推荐使用以下IDE进行开发:
- Visual Studio 2022:功能全面的.NET开发环境
- Visual Studio Code:轻量级跨平台编辑器,需安装C#扩展
数据库支持
OSharp框架通过EF Core支持多种数据库:
- Microsoft SQL Server 2012+
- MySQL 5.7+
- SQLite
- PostgreSQL
- Oracle
前端开发环境
Node.js安装
- 下载并安装最新LTS版本的Node.js
- 配置国内镜像源提升安装速度:
npm config set registry https://registry.npmmirror.com/
前端框架支持
OSharp目前提供:
- Angular版本:基于NG-ALAIN框架
- Vue版本:基于Vben Admin框架(开发中)
安装对应CLI工具:
# Angular
npm install -g @angular/cli
# Vue
npm install -g @vue/cli
项目初始化
安装项目模板
OSharp提供了便捷的dotnet CLI模板:
dotnet new -i OSharp.Template.WebApi
创建新项目
-
生成项目脚本:
dotnet new osharp
-
执行生成的
osharp.cmd
脚本 -
按提示输入项目名称,格式为"公司.项目",例如:
Liuliu.Blogs
项目结构解析
后端项目结构
解决方案根目录
└─src
├─Core # 业务核心层
│ ├─Common # 通用业务
│ ├─Identity # 身份认证
│ ├─Security # 权限安全
│ └─Systems # 系统模块
├─EntityConfiguration # 数据库映射
└─Web # Web宿主
├─Areas
├─Controllers
├─Hangfire
├─Migrations
└─Startups
前端项目结构(Angular)
ui/ng-alain
├── _mock # Mock数据
├── src
│ ├── app
│ │ ├── core # 核心模块
│ │ ├── layout # 通用布局
│ │ ├── routes # 业务路由
│ │ └── shared # 共享模块
│ ├── assets # 静态资源
│ ├── environments # 环境配置
│ └── styles # 样式文件
项目启动与配置
后端启动
- 在Visual Studio中设置Web项目为启动项
- 配置
appsettings.Development.json
中的数据库连接 - 按Ctrl+F5启动项目
启动后将看到Swagger API文档页面,验证API是否正常工作。
前端启动
- 使用VS Code打开前端项目
- 安装依赖:
npm install
- 启动开发服务器:
npm start
系统初始化与使用
- 首次访问系统需要注册用户
- 第一个注册用户自动成为超级管理员
- 通过后台管理界面可配置:
- 用户权限
- 系统功能
- 数据实体
常见问题解答
Q:数据库迁移失败怎么办? A:检查数据库连接字符串是否正确,确保数据库服务已启动,用户有足够权限。
Q:前端代理不生效? A:确认proxy.config.json中的target地址与后端服务地址一致。
Q:如何扩展业务模块? A:在Core项目中按现有模块结构添加新文件夹,实现相应接口和服务。
结语
通过本文的指导,您已经完成了OSharp框架的基本环境搭建和项目初始化。OSharp框架提供了丰富的企业级功能开箱即用,让开发者可以专注于业务逻辑的实现,大幅提升开发效率。接下来您可以基于生成的项目结构,开始您的业务功能开发。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考