【开源】OSharp框架解说系列（1）：总体设计及系列导航

系列文章导航

重要提示：

随着新的 .net core 平台的崛起，传统的.net framework 已经落没，osharp 的 .net fx 版本将进入维护阶段

osharp的core版本 osharpns 已经进入实用阶段，欢迎关注：https://github.com/i66soft/osharp-ns20

前言

OSharp是什么？

　　OSharp是个快速开发框架，但不是一个大而全的包罗万象的框架，严格的说，OSharp中什么都没有实现。与其他大而全的框架最大的不同点，就是OSharp只做抽象封装，不做实现。依赖注入、ORM、对象映射、日志、缓存等等功能，都只定义了一套最基础最通用的抽象封装，提供了一套统一的API、约定与规则，并定义了部分执行流程，主要是让项目在一定的规范下进行开发。所有的功能实现端，都是通过现有的成熟的第三方组件来实现的，除了EntityFramework之外，所有的第三方实现都可以轻松的替换成另一种第三方实现，OSharp框架正是要起隔离作用，保证这种变更不会对业务代码造成影响，使用统一的API来进行业务实现，解除与第三方实现的耦合，保持业务代码的规范与稳定。

　　前一个系列讲的主要是我对架构设计的理解以及怎样用好EntityFramework的一些想法，在技术细节上并没有太多的考究。不幸的是，不少同学把这个架构当作框架来用了，里边留的很多坑，坑苦了很多人，真是误人子弟，深表愧疚。于是重新整理代码，整理思路，鼓捣出了这个我们将要详解的开源框架：OSharp。这次，我们真的深入地说框架了，而不是架构那样只是蜻蜓点水。

　　关于OSharp：OSharp是我在“MVC EF 技术交流群”（5008599）发起的一个群内开源项目。项目名字来源也挺有意思，在头脑风暴起名时谁说的一句“O-Shit”，后来结合CSharp，演化成了OSharp。当时40多个群成员集资购买阿里云服务器作为TFS的服务器，本想以TFS为团队合作平台进行合力开发的，但后面由于组织不力，合作得并不是很理想，基本上不了了之。不过大家的热情还是深深的激励着我坚持按原来的想法把底层基本做成型了。于是便有了现在这个开源项目，一个架构上，兼容上来说很初级的框架。

　　OSharp是一个依赖于EntityFramework，专注于业务数据模型与EntityFramework解耦的适用于中小型项目开发的（插件式）框架。OSharp将支持基于OSGi.NET的插件式开发，但我们还是会从非插件式讲起，详细了解OSharp开发框架的方方面面。在本系列中，将会讲解到不少非常实用的技术与编码技巧，欢迎关注。

　　本系列使用的开发环境为：Windows7 SP1、Visual Studio 2013、Sql Server 2012，.NET Framework 4.5，github.com 代码托管，并使用 Resharper 8.0.2 进行代码优化。

　　温馨提示：本系列非入门级教程，对于基础知识不会做过多的讲解，读者最好对系统架构，IoC依赖注入，面向接口编程，EntityFramework数据存储等方面的知识有较好的理解。

架构图

OSharp开发框架架构图工程结构图

架构说明

使用技术（库）说明

技术平台：.NET Framework 4.5
技术框架：ASP.NET MVC5 + WebAPI + SignalR
数据存储：EntityFramework 6
数据序列化：使用JSON.NET作为JSON序列化的主要工具
数据映射：AutoMapper，主要用于数据传输对象DTO与数据实体模型Model之间的相互转化，免于繁杂的对象属性赋值
IoC组件：Autofac，定义了一个专用于处理映射的空接口IDependency，用于处理IoC接口与实现的批量映射，避免Autofac与各个层次耦合
日志记录：定义通用日志记录接口与基础API，日志输出方式可以使用现成的任意日志组件（如log4net）
缓存处理：未定
。。。

项目工程详解

通用工具组件：OSharp.Utility
说明：分类封装通用的与技术无关的辅助工具类功能
依赖项：JSON.NET
Web组件：OSharp.Web
说明：封装Web相关的Webform，MVC，WebApi，SignalR等Web技术的辅助功能
依赖项：1.OSharp.Utility，2.ASP.NET MVC，3.ASP.NET WebApi，4.SignalR，5.JSON.NET
OSharp框架核心组件：OSharp.Core
说明：1.定义OSharp框架的核心API，是整个框架运行的骨架
2.该骨架提供数据存储，缓存，权限等模块的基础接口或基类，不提供具体实现
3.业务层依赖于此层的接口与基类进行业务操作，而不依赖于具体的实现
4.日志API为了使用方便，已经迁移到OSharp.Utility
依赖项：OSharp.Utility
EntityFramework数据存储组件：OSharp.Core.Data.Entity
说明：1.提供OSharp.Core中定义的数据存储功能的EntityFramework的实现方案
2.本框架的数据组件将不做各个ORM的兼容性处理，为充分发挥EntityFramework的性能优化，本框架将强依赖于EntityFramework
依赖项：1.OSharp.Utility，2.OSharp.Core，3.EntityFramework，4.AutoMapper
普通（非插件式）示例工程：OSharp.Demo.Web
说明：1.为尽量简化项目结构，本工程不采用类库划分层次，而采用文件夹分层方式
2.各文件夹说明如下：
　2.1 Models：用于EntityFramework数据存储操作的数据实体模型，与数据库中的表对应
　2.2 EntityConfigurations：数据实体与数据库的映射类，实体将依靠这些映射类加载到与业务解耦的上下文中，并使用 Fluent API 配置数据映射的细节
　2.3 Dtos：DTO是业务层的输入信息，Controller与业务层之间通信数据的承载体，用户的交互数据将以“DTO+简单类型数据”的形式传递到业务层中进行处理，DTO与Model之间的映射使用AutoMapper来进行，以减少繁杂的属性赋值操作和增加代码的可维护性
　2.4 Services：业务契约，业务实现将以模块为划分，而不是以实体为划分。以模块为划分单元，可增强业务操作的内聚性，但为了方便处理各个实体的业务，推荐使用局部类（partial）的方式来组织实现层的代码
依赖项：1. OSharp.Utility，2. OSharp.Web，3. OSharp.Plugin，4. OSharp.Core，5. ASP.NET MVC