基于nopCommerce的开发框架 附源码
.net的开发人员应该都知道这个大名鼎鼎的高质量b2c开源项目-nopcommerce,基于entityframework和mvc开发,拥有透明且结构良好的解决方案,同时结合了开源和商业软件的最佳特性。官网地址:,中文网:。下载后前后端展示如下。如果你还未了解过该项目,建议从官网下载代码后在本地运行查看效果。
笔者使用该框架开发过不少项目,总的来说,方便简洁,集成了.net开发许多常用的组件和功能。一直想将它分享出来,但忙于工作而没有达成,最近也是有时间来写这篇文章,本文将展示如何提取该源码的精简框架并附上源码(基于nopcommerce3.9版本)。如果你想了解框架结构,通过该框架来开发项目,那么看一遍该文章是有价值的。前排提示:本框架源码已上传到github:https://github.com/dreling8/nop.framework,有兴趣的可以关注该项目,后续会将其它的一些通用模块添加进去,如用户管理(iworkcontext 工作上下文)、插件功能、任务模块(taskservice)、日志、缓存、本地化等。欢迎star给星星,你的支持是我的动力!
一、了解项目结构
从项目结构图中我们也可以看出nop的层次划分非常清晰,先看我画的层次图
1. 展现层(presentation)
也可称之为应用层,只关注前端的整合,不涉及任何领域逻辑实现。这一层只做展现,对我们框架来说是可有可无的,因此提取框架时会将该层删除。
2. 业务服务层(nop.services)
整个系统的服务层,提供了对每个领域的接口和实现。这一层非常重要,提供了程序内对展现层的接口服务,不论展现层使用mvc,还是使用winform,异或是给app调用的webapi接口,都需要该层服务。但该层的服务主要是电商的一些服务,对我们框架无用,因此在这个框架中会删除所有服务,只添加一个测试服务类和接口,应用到项目中你应该在该层添加接口和服务。
3. 数据层(nop.data)
nop在数据层的仓储实现中使用了ef和sqlserver数据库,如果你想扩展,也可以在该层使用其它的orm映射库和数据库。这一层的大部分功能我们会在框架中将保留。
4. 基础设施层(nop.core)
包括缓存的实现、配置、领域模型等等。在框架中会保留一部分功能,并将domain领域模型移出该层做单独项目,为什么要这样做,因为通常情况下,domain层的调整会比较多,所以我一般将domain做单独project,当然你也可以不调整,但框架做了该调整。
二、删除与业务相关的代码
我们已经对nop的整个代码层次结构有了了解,基于以下两点开始修改项目源码:1.框架足够精简,没有任何电商业务。2.核心功能保留。建议在开始前先copy一份源码保留。
1. test项目:tests文件夹下面是测试项目,不是必需的,将它全部移除,开发具体业务,可以再单独添加测试项目。由于是测试项目,删除后整个项目还能跑起来。
2. presentation展现层:这里的三个项目,分别是前台,后端和两个项目共用的一些模块。和测试项目一样,这里我们也全部移除。
3. plugin项目:插件项目,同1、2一样,插件也不是必需的,移除所有的插件项目。现在只剩下三个项目了(欢迎关注该项目的github,后续我会专门写篇文章介绍如何添加插件)。
nop.services:业务服务层,这一层是程序集内对外接口层,需要保留。删除所有相关的业务服务类,其中日志、帮助、任务等跟系统相关的都删除,目的是更好的展示整个系统的结构。添加一个测试类,暂时什么都不写。
nop.data:数据层项目。这层基本不做调整,只删除ef的mapping映射相关类。
nop.core:基础设施层。删除电商业务相关的domain,新建项目nop.domain。
报错了,iworkcontext(工作上下文,用于获取用户信息等数据)依赖domain,删除它。这个过程可能要删除不少文件,直到项目不再报错。完成后我们的项目结构如下,注意我们将nop.core中的实体基类移到了nop.domain中,到这一步,我们的基础框架结构已经大致出来了。
三、添加数据库、数据实体、映射、业务层代码
1. 在本地sqlserver中,新建数据库myproject,添加表test。
use [myproject] go /****** object: table [dbo].[test] script date: 05/24/2017 23:51:21 ******/ set ansi_nulls on go set quoted_identifier on go create table [dbo].[test]( [id] [int] not null, [name] [nvarchar](50) not null, [description] [nvarchar](200) null, [createdate] [datetime] null, constraint [pk_test] primary key clustered [id] asc )with (pad_index = off, statistics_norecompute = off, ignore_dup_key = off, allow_row_locks = on, allow_page_locks = on) on [primary] ) on [primary]
2. 添加实体类和映射。在domain项目下面新建test目录,添加testentity。data项目mapping下新建test目录,添加ef映射类。
public class testentity: baseentity { public virtual string name { get; set; } public virtual string description { get; set; } public virtual datetime? createdate { get; set; } }
3. 添加业务层方法。
在nop.services项目里,在我们之前添加的接口和类下面添加几个常用的curd方法,并实现它。这样我们就已经实现的业务层的代码了。
/// <summary> /// test service interface /// </summary> public partial interface itestservice { /// <summary> /// gets all tests /// </summary> /// <returns>tests</returns> ilist<testentity> getalltests(); /// <summary> /// gets a test /// </summary> /// <param name="testid">the test identifier</param> /// <returns>test</returns> testentity gettestbyid(int testid); /// <summary> /// inserts a test /// </summary> /// <param name="test">test</param> void inserttest(testentity test); /// <summary> /// updates the test /// </summary> /// <param name="test">test</param> void updatetest(testentity test); /// <summary> /// deletes a test /// </summary> /// <param name="test">test</param> void deletetest(testentity test); }
/// <summary> /// test service /// </summary> public partial class testservice : itestservice { #region constants #endregion #region fields private readonly irepository<testentity> _testrepository; #endregion #region ctor public testservice(irepository<testentity> testrepository) { this._testrepository = testrepository; } #endregion #region methods /// <summary> /// gets all tests /// </summary> /// <returns>tests</returns> public virtual ilist<testentity> getalltests() { return _testrepository.table.where(p => p.name != null).tolist(); } /// <summary> /// gets a topic /// </summary> /// <param name="testid">the test identifier</param> /// <returns>test</returns> public virtual testentity gettestbyid(int testid) { if (testid == 0) return null; return _testrepository.getbyid(testid); } /// <summary> /// inserts a test /// </summary> /// <param name="test">test</param> public virtual void inserttest(testentity test) { if (test == null) throw new argumentnullexception("test"); _testrepository.insert(test); } /// <summary> /// updates the test /// </summary> /// <param name="test">test</param> public virtual void updatetest(testentity test) { if (test == null) throw new argumentnullexception("test"); _testrepository.update(test); } /// <summary> /// deletes a test /// </summary> /// <param name="test">test</param> public virtual void deletetest(testentity test) { if (test == null) throw new argumentnullexception("test"); _testrepository.delete(test); } #endregion }
四、添加presentation项目
有了业务服务,现在可以添加表现层项目来测试了。为什么不直接写测试项目?因为测试项目使用mock模拟数据,不能完整展示整个功能。
1. 添加mvc模板项目,通过nuget引入autofac和autofac.mvc5。
2. 添加容器注册类dependencyregistrar,实现idependencyregistrar接口,这一步非常关键,我们将要用的接口和实现类注入到容器中。
/// <summary> /// dependency registrar /// </summary> public class dependencyregistrar : idependencyregistrar { /// <summary> /// register services and interfaces /// </summary> /// <param name="builder">container builder</param> /// <param name="typefinder">type finder</param> /// <param name="config">config</param> public virtual void register(containerbuilder builder, itypefinder typefinder, nopconfig config) { //注入objectcontext builder.register<idbcontext>(c => new nopobjectcontext("test")).instanceperlifetimescope(); // 注入ef到仓储 builder.registergeneric(typeof(efrepository<>)).as(typeof(irepository<>)).instanceperlifetimescope(); // 注入service及接口 builder.registerassemblytypes(typeof(testservice).assembly) .asimplementedinterfaces() .instanceperlifetimescope(); //注入controllers builder.registercontrollers(typefinder.getassemblies().toarray()); } /// <summary> /// order of this dependency registrar implementation /// </summary> public int order { get { return 2; } } }
3. 配置文件中添加数据库访问节点
4. 应用启动时添加初始化引擎上下文
启动项目,这时nopengine会报错,因为我们没有使用nopconfig来配置项目,在registerdependencies方法中注释nopconfig的注入,同时在initialize过程中将相关代码注释。这样就完成通过autofac注入类到容器中。
public class mvcapplication : system.web.httpapplication { protected void application_start() { arearegistration.registerallareas(); filterconfig.registerglobalfilters(globalfilters.filters); routeconfig.registerroutes(routetable.routes); bundleconfig.registerbundles(bundletable.bundles); //引擎上下文初始化 enginecontext.initialize(false); } }
//registerdependencies方法中注释nopconfig的注入 //builder.registerinstance(config).as<nopconfig>().singleinstance(); public void initialize(nopconfig config) { //register dependencies registerdependencies(config); //没有使用config,暂时注释 //register mapper configurations //registermapperconfiguration(config); //startup tasks 没有启用任务,注释 //if (!config.ignorestartuptasks) //{ // runstartuptasks(); //} }
5. 在controller添加测试代码。将service添加到homecontroller,在构造函数中初始化。系统启动后会自动注入实例。通过断点我们看到,数据成功添加到了数据库。
public class homecontroller : controller { public itestservice _testservice; public homecontroller( itestservice testservice ) { _testservice = testservice; } public actionresult index() { var entity = new testentity() { createdate = datetime.now, description = "描述2", name = "测试数据2" }; _testservice.inserttest(entity); var tests = _testservice.getalltests(); return view(); }
五、扩展到webapi、winform、wpf
现在再添加一个winform项目,同样的步骤添加相关的代码。在winform中我们也能使用业务的服务了。
1. 通过nuget安装autofac,entityframework, 添加项目libraries下的引用。
2. 添加依赖注册类,因为是winform项目,dependencyregistrar这里需要做些调整,建议定义一个空接口iregistrarform,需要注入的form实现iregistrarform。
/// <summary> /// dependency registrar /// </summary> public class dependencyregistrar : idependencyregistrar { /// <summary> /// register services and interfaces /// </summary> /// <param name="builder">container builder</param> /// <param name="typefinder">type finder</param> /// <param name="config">config</param> public virtual void register(containerbuilder builder, itypefinder typefinder, nopconfig config) { //注入objectcontext builder.register<idbcontext>(c => new nopobjectcontext("test")).instanceperlifetimescope(); // 注入ef到仓储 builder.registergeneric(typeof(efrepository<>)).as(typeof(irepository<>)).instanceperlifetimescope(); // 注入service及接口 builder.registerassemblytypes(typeof(testservice).assembly) .asimplementedinterfaces() .instanceperlifetimescope(); //注入controllers //builder.registercontrollers(typefinder.getassemblies().toarray()); //注入forms var types = appdomain.currentdomain.getassemblies() .selectmany(a => a.gettypes().where(t => t.getinterfaces().contains(typeof(iregistrarform)))) .toarray(); foreach (var formtype in types) { builder.registerassemblytypes(formtype.assembly); } } /// <summary> /// order of this dependency registrar implementation /// </summary> public int order { get { return 2; } } }
3. 在启动时添加 enginecontext.initialize(false),启动项目,报错了,因为winform不能执行,对方法做些调整,添加一个参数isform表示是否是winform,默认为false。
/// <summary> /// initializes a static instance of the nop factory. /// </summary> /// <param name="forcerecreate">creates a new factory instance even though the factory has been previously initialized.</param> /// <param name="iswinform">是否客户端程序</param> [methodimpl(methodimploptions.synchronized)] public static iengine initialize(bool forcerecreate,bool iswinform = false) { if (singleton<iengine>.instance == null || forcerecreate) { singleton<iengine>.instance = new nopengine(); nopconfig config = null; if (!iswinform) { config = configurationmanager.getsection("nopconfig") as nopconfig; } else { //如果使用winform,使用此代码读取配置初始化nopconfig var appsettings = configurationmanager.appsettings; foreach (var key in appsettings.allkeys) { } } singleton<iengine>.instance.initialize(config); } return singleton<iengine>.instance; }
static class program { /// <summary> /// 应用程序的主入口点。 /// </summary> [stathread] static void main() { application.enablevisualstyles(); application.setcompatibletextrenderingdefault(false); //application.run(new form1()); //引擎上下文初始化 enginecontext.initialize(false, true); application.run(enginecontext.current.resolve<form1>()); } }
4. from1中测试,成功调用了业务层的方法,这里我们并没有实例化itestservice,而是交给依赖注入自动实现。
public partial class form1 : form, iregistrarform { private itestservice _testservice; public form1( itestservice testservice ) { initializecomponent(); _testservice = testservice; //如果不注入form可以使用enginecontext.current.resolve<itestservice>(); 得到实例 } private void button1_click(object sender, eventargs e) { var tests = _testservice.getalltests(); } }
至此,基于nop的精简开发框架基本完成,如果你有兴趣,建议在github关注该项目 :https://github.com/dreling8/nop.framework,欢迎star给星星,你的支持是我的动力!
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
推荐阅读
-
基于nopCommerce的开发框架 附源码
-
【基于EF Core的Code First模式的DotNetCore快速开发框架】完成对DB First代码生成的支持
-
Python 基于Twisted框架的文件夹网络传输源码
-
Android编程基于Contacts读取联系人的方法(附demo源码)
-
Python 基于Twisted框架的文件夹网络传输源码
-
基于spring+hibernate+JQuery开发之电子相册(附源码下载)
-
Android编程基于Contacts读取联系人的方法(附demo源码)
-
基于spring+hibernate+JQuery开发之电子相册(附源码下载)
-
基于GridView和ActivityGroup实现的TAB分页(附源码)
-
Python基于pygame实现的弹力球效果(附源码)