OSharp是什么?
OSharp是个快速开发框架,但不是一个大而全的包罗万象的框架,严格的说,OSharp中什么都没有实现。与其他大而全的框架最大的不同点,就是OSharp只做抽象封装,不做实现。依赖注入、ORM、对象映射、日志、缓存等等功能,都只定义了一套最基础最通用的抽象封装,提供了一套统一的API、约定与规则,并定义了部分执行流程,主要是让项目在一定的规范下进行开发。所有的功能实现端,都是通过现有的成熟的第三方组件来实现的,除了EntityFramework之外,所有的第三方实现都可以轻松的替换成另一种第三方实现,OSharp框架正是要起隔离作用,保证这种变更不会对业务代码造成影响,使用统一的API来进行业务实现,解除与第三方实现的耦合,保持业务代码的规范与稳定。
本文已同步到系列目录:OSharp快速开发框架解说系列
前言
经过一段时间的努力,OSharp项目又有了全新的面貌,目前版本号已经更新到 3.3.2(github.com、nuget),与之前3.0的版本又有了很大的差异。
有些项目被拆分了,有些项目又被合并了,又新增了不少项目,有人就要问了,为什么不向前兼容呢?
这个是比较无奈的事,有些是因为之前设计考虑不周,设计有缺陷,也有些是因为后面又有了更好的想法,也就不断的改进了,至少总是不断向好的方向发展的。并且现在框架处于开发阶段,不能保持稳定,不断调整是在所难免的。
重新开源
经过这段时间的发展,OSharp项目已经比较算比较成熟了,能看得过眼,算是拿得出手了,现在也重新提交到了github开源平台中,开源地址依然为:
之前的旧版本,已经更名为osharp.v2,旧版本的地址为:https://github.com/i66soft/osharp.v2,请注意区分。
欢迎大家关注(Watch)、支持(Star)、参与(Fork)《OSharp快速开发框架》开源项目的发展。
3.3版本新特性及项目组成
新特性
下面我们还是先来看看,截止到目前为止,当前版本的一些新特性吧。
- 自定义了一个Web.Config的配置节点,用于配置框架中一些必要的开关,初始化环境等。当然,基于“约定胜于配置”的传统,这些配置不是必须的,如果不使用配置节点,系统也能按一套默认的设置来正常运行。
- 从框架级别对框架初始化进行了抽象,框架定义了初始化流程,具体的第三方组件,仅作为具体的服务实现存在。
- 参考 ASP.NET 5 的依赖注入设计,从框架级别提供了依赖注入的抽象封装,可以极其方便的使用第三方IoC组件实现依赖注入功能。
- 参考 ASP.NET 5 的“一切皆服务”的设计思想,配合第2点对依赖注入的支持,很容易构建一套可组装的松耦合的架构,一切变化点的实现方案均可很容易进行替换。
- 基于 ASP.NET Identity 的权限系统设计,一切权限均可配置,可以很轻松实现角色-功能、用户-功能、角色-数据、用户-数据等细粒度的功能权限与数据权限控制。
项目组成
我们来看看这个版本相对于之前的版本,项目结构有何变化,下面这三张图片的对比,可以一目了然的展现OSharp的发展历程:
OSharp 2.0
OSharp2.0版本只是简单的三层架构,主要是实现了EntityFramework的动态上下文构建的功能,MVC/WebApi/SignalR等平台的相关代码,仅是作为辅助工具组件的形式存在,架构上比较简单。
OSharp 3.0
OSharp3.0对增加了一个SiteBase项目,系统初始化也初具雏形,但仍然极其简单,依赖注入功能的实现仍然强依赖于Autofac,没有进行解耦。对MVC/WebApi等平台的整合有了一些封装,但平台间没有进行分离,而是杂合在一个类库中,相互污染程度比较大。
OSharp 3.3
OSharp3.3由依赖注入的抽象封装开始,以MVC6的“一切皆服务”的架构思想,对整个架构进行了大改,并严格隔离了MVC/WebApi/SignalR等平台,使之互不影响,并可单独构建运行环境,同时加入了权限认证的支持。
乍一看,似乎 OSharp 3.3 版本的类库数量增加了很多个,其实也没增加多少的,只是把原来整合在一起的构架按 Mvc/WebApi/SignalR 等平台进行了拆分,拆分了之后,能更灵活的对需要的功能进行引用,不必引用使用不到的功能。
3.3版本类库功能及依赖说明
工具类库
- OSharp.Utility
- 作用:工具类组件,对常用工具类辅助操作进行封装
- 依赖项:Json.NET
框架核心类库
- OSharp.Core
- 作用:框架核心组件,为框架定义配置节点,依赖注入,数据访问,日志,缓存,框架初始化,基础数据等功能的基础类、核心接口等
- 依赖项:OSharp.Utility
- OSharp.Core.Data.Entity:
- 作用:数据访问组件,封装基于EntityFramework的数据访问功能的实现
- 依赖项:OSharp.Core,EntityFramework,EntityFramework.Extended,AutoMapper
- OSharp.Core.Data.Entity.MySql
- 作用:MySql数据访问组件,对数据访问组件提供基于EntityFramework的数据访问功能的MySql数据库的支持
- 依赖项:OSharp.Core.Data.Entity,MySql.Data.Entity
技术平台类库
MVC平台
- OSharp.Web.Mvc
- 作用:ASP.NET MVC 组件,封装MVC通用操作及MVC平台初始化实现
- 依赖项:OSharp.Core.Data.Entity,OWin,ASP.NET MVC5
- OSharp.Autofac.Mvc
- 作用:ASP.NET MVC 的Autofac依赖注入组件,基于Autofac对框架的MVC平台的依赖注入功能进行实现
- 依赖项:OSharp.Core,ASP.NET MVC5,Autofac.Integration.Mvc
WebApi平台
- OSharp.Web.WebApi
- 作用:ASP.NET WebApi 组件,封装WebApi通用操作及WebApi平台初始化实现
- 依赖项:OSharp.Core.Data.Entity,OWin,ASP.NET WebApi5
- OSharp.Autofac.WebApi
- 作用:ASP.NET WebApi 的Autofac依赖注入组件,基于Autofac对框架的WebApi平台的依赖注入功能进行实现
- 依赖项:OSharp.Core,ASP.NET WebApi5,Autofac.Integration.WebApi
SignalR平台
- OSharp.Web.SignalR
- 作用:ASP.NET SignalR 组件,封装SignalR通用操作及SignalR平台初始化实现
- 依赖项:OSharp.Core.Data.Entity,OWin,ASP.NET SignalR2
- OSharp.Autofac.SignalR
- 作用:ASP.NET SignalR 的Autofac依赖注入组件,基于Autofac对框架的SignalR平台的依赖注入功能进行实现
- 依赖项:OSharp.Core,ASP.NET SignalR2,Autofac.Integration.SignalR
本地程序平台
- OSharp.App.Local
- 作用:本地程序组件,封装Winform/WPF/Services/Console等形式的本地应用程序提供框架初始化功能
- 依赖项:OSharp.Core,Autofac
- OSharp.Web.Client
- 作用:本地程序网络组件:封装Winform/WPF/Services/Console等形式的本地应用程序提供WebApi/SignalR等网络功能
- 依赖项:OSharp.Utility,ASP.NET WebApi4 Client,ASP.NET SignalR Client
辅助类库(可选)
- OSharp.Core.Permissions
- 作用:用户认证权限组件:基于 ASP.NET Identity 提供用户认证与功能权限、数据权限的验证功能的基础实现
- 依赖项:OSharp.Core.Data.Entity,ASP.NET Identity Core
- OSharp.Logging.Log4Net
- 作用:log4net日志组件:基于log4net对日志记录功能进行实现
- 依赖项: OSharp.Core,log4net
开源说明
github.com
OSharp项目已在github.com上开源,地址为:https://github.com/i66soft/osharp,欢迎阅读代码,欢迎 Watch(关注),欢迎 Star(推荐),如果您认同 OSharp 项目的设计思想,欢迎参与 OSharp 项目的开发。
在Visual Studio 2013中,可直接获取 OSharp 的最新源代码,获取方式如下,地址为:https://github.com/i66soft/osharp.git
开源项目参与方式
很多童鞋想参与开源项目,为项目做贡献,但又不知道如何做,这里我简单说下参与OSharp的步骤吧:
- 在 https://github.com/i66soft/osharp 右上角 Fork 一下项目源码,在你的账户下会有一份代码的副本
- 使用VisualStudio Clone 你账户下的代码到本地,更改代码,再提交,就完成代码的更改了
- 如果觉得有并入 i66soft 主干的价值,可以向主干提交 pull request申请,如果我审核通过,就可以合并到主干了,这就形成了一次开源代码的贡献了
- 如果我没有接受合并,你也可以在你的账户上按你的风格去发展osharp
- 我也会经常浏览各个Fork版本对项目的更改,如果觉得有价值,也会主动合并到主干代码中,也能形成一次对开源的贡献
- 为保证提交的质量,也便于对代码的合并,每次更改与提交应该只做一件事,只提交必要的更改
nuget
OSharp的相关类库已经发布到nuget上,欢迎试用,直接在nuget上搜索 “osharp” 关键字即可找到
系列导航
本文已同步到系列目录:OSharp快速开发框架解说系列