开源]OSharpNS 步步为营系列 - 1. 业务模块设计

OSharpNS全称OSharp Framework with .NetStandard2.0，是一个基于.NetStandard2.0开发的一个.NetCore快速开发框架。这个框架使用最新稳定版的.NetCore SDK（当前是.NET Core 2.2），对 AspNetCore 的配置、依赖注入、日志、缓存、实体框架、Mvc(WebApi)、身份认证、权限授权等模块进行更高一级的自动化封装，并规范了一套业务实现的代码结构与操作流程，使 .Net Core 框架更易于应用到实际项目开发中。

开源地址：https://github.com/i66soft/osharp
官方示例：https://www.osharp.org
文档中心：https://docs.osharp.org
VS 插件：https://marketplace.visualstudio.com/items?itemName=LiuliuSoft.osharp

本系列教程中，我们将一步一步实现一个博客(BlogsPack)的业务模块，并对使用OSharp框架进行业务实现的过程涉及的框架知识进行全面的讲解。
通过学习本系列教程，你将对OSharp框架的业务实现有个较全面的了解，你将学习到框架的如下知识点：

框架推荐的项目文件组织方式
实体类设计，并将实体类加载到数据上下文
模块化的业务层服务设计
基于WebAPI的角色 功能权限 控制
基于角色-实体的 数据权限 控制
Angular前端 菜单/按钮权限 控制

Pack模块是应用程序中的一个高内聚的子系统，负责完成一类功能或者一系列相关联的业务处理，是构建 OSharp 应用程序的基本功能单元。一系列低耦合的Pack模块共同组合在一起创建一个 OSharp 应用程序。每个 Pack模块是以一个实现了模块基类（OsharpPack）的类作为入口的，这个类完成本模块的服务添加（AddService）和模块初始化工作（UsePack）。

OsharpPack 基类定义如下：

public abstract class OsharpPack{public virtual PackLevel Level => PackLevel.Business;      

public virtual int Order => 0;      

public bool IsEnabled { get; protected set; } 

public virtual IServiceCollection AddServices(IServiceCollection services){return services;    }

public virtual void UsePack(IServiceProvider provider){        IsEnabled = true;    }

internal Type[] GetDependPackTypes(Type packType = null){

    }}

一个完整的业务模块，要实现一系列相关联的业务功能，需要一个完整的 数据层 - 服务层 - WebAPI层 - 前端UI层 的代码链的支持，各个层次各司其职，共同来完成当前模块的业务处理。

业务模块文件夹结构布局

OSharp框架有一套推荐的模块文件夹布局方案，根据该方案，博客Blogs模块的 后端文件夹 结构推荐如下：

src                                         ├─Liuliu.Blogs.Core                         │  └─Blogs                                  │      ├─BlogsPack.cs                       │      ├─BlogsService.cs                    │      ├─BlogsService.Blog.cs               │      ├─BlogsService.Post.cs               │      ├─IBlogsContract.cs                  │      ├─Dtos                               │      │    ├─BlogInputDto.cs               │      │    ├─BlogOutputDto.cs              │      │    ├─PostInputDto.cs               │      │    └─PostOutputDto.cs              │      └─Entities                           │           ├─Blog.cs                       │           └─Post.cs                       ├─Liuliu.Blogs.EntityConfiguration          │  └─Blogs                                  │      ├─BlogConfiguration.cs               │      └─PostConfiguration.cs               └─Liuliu.Blogs.Web                              └─Areas                                        └─Admin                                          └─Controllers                                   └─Blogs                                         ├─BlogController.cs                         └─PostController.cs

博客Blogs模块相应的 Angular 前端文件夹 结构推荐如下：

src                                         └─app                                          └─routes                                        └─blogs                                         ├─blogs.module.ts                           ├─blogs.routing.ts                          ├─blog                                      │   ├─blog.component.html                   │   └─blog.component.ts                     └─post                                           ├─post.component.html                       └─post.component.ts

博客业务需求分析

已登录 并且未开通博客的用户，可以向系统申请开通博客
博客管理员 审核并开通博客，并给相应用户分配博主角色
博客管理员 可以对博客、文章进行 更新、删除 的管理操作
博主可以对博客进行更新操作
博主可以对文章进行 新增、更新、删除 操作
博客、文章均开启 逻辑删除 功能，保留历史数据

数据层

OSharp的数据层，主要是 数据实体 的定义，只要数据实体定义好，并做好 数据实体映射，再配合框架中已定义好的数据仓储 IRepository<TEntity, TKey>，即可轻松完成数据的数据库存取操作。
一个最简单的博客系统，需要有作者、博客、文章三个数据实体。

作者 - User

博客系统的作者就是OSharp框架的 用户(User)，直接使用即可。

博客 - Blog

Id	int	博客编号	主键，唯一	是	是
Url	string	博客地址	唯一	是	是
Display	string	博客显示名称		是	是
IsEnabled	boolean	已开通		否	是
CreatedTime	DateTime	创建时间		否	是
DeletedTime	DateTime	逻辑删除时间	可空	否	否
UserId	int	博主编号	外键，一对一	否	是

文章 - Post

Id	int	文章编号	主键，唯一	是	是
Title	string	文章标题		是	是
Content	string	文章内容		是	是
CreatedTime	DateTime	创建时间		否	是
DeletedTime	DateTime	逻辑删除时间	可空	否	否
BlogId	int	博客Id	外键，多对一	否	是
UserId	int	作者编号	外键，多对一	否	是

服务层

服务层负责实现模块的业务处理，是整个系统的最核心部分，一个系统有什么功能，能对外提供什么样的服务，都是在服务层实现的。

博客	申请开通、开通审核、更新、删除
文章	新增、更新、删除

WebAPI层

WebAPI层负责对外提供数据操作API，并对API进行授权约束。

博客管理 - Blog

申请开通	登录访问	已登录未开通博客的用户
读取	角色访问	博客管理员、博主
开通审核	角色访问	博客管理员
更新	角色访问	博客管理员、博主
删除	角色访问	博客管理员

文章管理 - Post

读取	角色访问	博客管理员、博主
新增	角色访问	博主
更新	角色访问	博客管理员、博主
删除	角色访问	博客管理员、博主

前端UI层

前端UI层是整个系统的对外操作界面，是直面最终用户的终端，整个系统最终表现形式全靠前端展现出现。
博客模块UI设计如下：

统一使用后台管理界面来提供博客、文章的管理
博客管理列表
- 可以对博客进行审核、更新、删除操作
- 已登录未开通博客，显示开通按钮
- 申请之后，博客处理未审核状态
- 博客更新可用
- 博主
- 博客管理员
文章管理列表
- 博主可以新增文章
- 博主、博客管理员可以更新、删除文章

至此，博客模块的详细设计设计完毕，后面我们将一步一步来实现这个业务需求。

原文地址：https://www.cnblogs.com/guomingfeng/p/osharpns-steps-index.html

.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com