基于nopCommerce開發(fā)框架的示例分析

這篇文章給大家分享的是有關(guān)基于nopCommerce開發(fā)框架的示例分析的內(nèi)容。小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考，一起跟隨小編過來看看吧。

　　.NET的開發(fā)人員應(yīng)該都知道這個(gè)大名鼎鼎的高質(zhì)量b2c開源項(xiàng)目-nopCommerce，基于EntityFramework和MVC開發(fā)，擁有透明且結(jié)構(gòu)良好的解決方案，同時(shí)結(jié)合了開源和商業(yè)軟件的最佳特性。官網(wǎng)地址：http://www.nopcommerce.com/，中文網(wǎng)：http://www.nopcn.com/。下載后前后端展示如下。如果你還未了解過該項(xiàng)目，建議從官網(wǎng)下載代碼后在本地運(yùn)行查看效果。

一、了解項(xiàng)目結(jié)構(gòu)

　　從項(xiàng)目結(jié)構(gòu)圖中我們也可以看出Nop的層次劃分非常清晰，先看我畫的層次圖

1. 展現(xiàn)層（Presentation）

　　也可稱之為應(yīng)用層，只關(guān)注前端的整合，不涉及任何領(lǐng)域邏輯實(shí)現(xiàn)。這一層只做展現(xiàn)，對我們框架來說是可有可無的，因此提取框架時(shí)會(huì)將該層刪除。

2. 業(yè)務(wù)服務(wù)層（Nop.Services）

　　整個(gè)系統(tǒng)的服務(wù)層，提供了對每個(gè)領(lǐng)域的接口和實(shí)現(xiàn)。這一層非常重要，提供了程序內(nèi)對展現(xiàn)層的接口服務(wù)，不論展現(xiàn)層使用mvc，還是使用winform，異或是給app調(diào)用的webapi接口，都需要該層服務(wù)。但該層的服務(wù)主要是電商的一些服務(wù)，對我們框架無用，因此在這個(gè)框架中會(huì)刪除所有服務(wù)，只添加一個(gè)測試服務(wù)類和接口，應(yīng)用到項(xiàng)目中你應(yīng)該在該層添加接口和服務(wù)。

3. 數(shù)據(jù)層（Nop.Data）

　　nop在數(shù)據(jù)層的倉儲(chǔ)實(shí)現(xiàn)中使用了ef和sqlserver數(shù)據(jù)庫，如果你想擴(kuò)展，也可以在該層使用其它的ORM映射庫和數(shù)據(jù)庫。這一層的大部分功能我們會(huì)在框架中將保留。

4. 基礎(chǔ)設(shè)施層（Nop.Core）

　　包括緩存的實(shí)現(xiàn)、配置、領(lǐng)域模型等等。在框架中會(huì)保留一部分功能，并將Domain領(lǐng)域模型移出該層做單獨(dú)項(xiàng)目，為什么要這樣做，因?yàn)橥ǔＧ闆r下，Domain層的調(diào)整會(huì)比較多，所以我一般將Domain做單獨(dú)Project，當(dāng)然你也可以不調(diào)整，但框架做了該調(diào)整。

二、刪除與業(yè)務(wù)相關(guān)的代碼

　　我們已經(jīng)對Nop的整個(gè)代碼層次結(jié)構(gòu)有了了解，基于以下兩點(diǎn)開始修改項(xiàng)目源碼：1.框架足夠精簡，沒有任何電商業(yè)務(wù)。2.核心功能保留。建議在開始前先copy一份源碼保留。

1. Test項(xiàng)目：Tests文件夾下面是測試項(xiàng)目，不是必需的，將它全部移除，開發(fā)具體業(yè)務(wù)，可以再單獨(dú)添加測試項(xiàng)目。由于是測試項(xiàng)目，刪除后整個(gè)項(xiàng)目還能跑起來。

2. Presentation展現(xiàn)層：這里的三個(gè)項(xiàng)目，分別是前臺(tái)，后端和兩個(gè)項(xiàng)目共用的一些模塊。和測試項(xiàng)目一樣，這里我們也全部移除。

3. Plugin項(xiàng)目：插件項(xiàng)目，同1、2一樣，插件也不是必需的，移除所有的插件項(xiàng)目?，F(xiàn)在只剩下三個(gè)項(xiàng)目了（歡迎關(guān)注該項(xiàng)目的github，后續(xù)我會(huì)專門寫篇文章介紹如何添加插件）。

　　Nop.Services：業(yè)務(wù)服務(wù)層，這一層是程序集內(nèi)對外接口層，需要保留。刪除所有相關(guān)的業(yè)務(wù)服務(wù)類，其中日志、幫助、任務(wù)等跟系統(tǒng)相關(guān)的都刪除，目的是更好的展示整個(gè)系統(tǒng)的結(jié)構(gòu)。添加一個(gè)測試類，暫時(shí)什么都不寫。

　　Nop.Data：數(shù)據(jù)層項(xiàng)目。這層基本不做調(diào)整，只刪除EF的Mapping映射相關(guān)類。

　　Nop.Core：基礎(chǔ)設(shè)施層。刪除電商業(yè)務(wù)相關(guān)的Domain，新建項(xiàng)目Nop.Domain。

　　報(bào)錯(cuò)了，IWorkContext（工作上下文，用于獲取用戶信息等數(shù)據(jù)）依賴Domain，刪除它。這個(gè)過程可能要?jiǎng)h除不少文件，直到項(xiàng)目不再報(bào)錯(cuò)。完成后我們的項(xiàng)目結(jié)構(gòu)如下，注意我們將Nop.Core中的實(shí)體基類移到了Nop.Domain中，到這一步，我們的基礎(chǔ)框架結(jié)構(gòu)已經(jīng)大致出來了。

三、添加數(shù)據(jù)庫、數(shù)據(jù)實(shí)體、映射、業(yè)務(wù)層代碼

1. 在本地Sqlserver中，新建數(shù)據(jù)庫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. 添加實(shí)體類和映射。在Domain項(xiàng)目下面新建Test目錄，添加TestEntity。Data項(xiàng)目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. 添加業(yè)務(wù)層方法。

　　在Nop.Services項(xiàng)目里，在我們之前添加的接口和類下面添加幾個(gè)常用的CURD方法，并實(shí)現(xiàn)它。這樣我們就已經(jīng)實(shí)現(xiàn)的業(yè)務(wù)層的代碼了。

/// <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項(xiàng)目

　　有了業(yè)務(wù)服務(wù)，現(xiàn)在可以添加表現(xiàn)層項(xiàng)目來測試了。為什么不直接寫測試項(xiàng)目？因?yàn)闇y試項(xiàng)目使用Mock模擬數(shù)據(jù)，不能完整展示整個(gè)功能。

　　1. 添加mvc模板項(xiàng)目，通過nuget引入Autofac和Autofac.Mvc5。

　　2. 添加容器注冊類DependencyRegistrar，實(shí)現(xiàn)IDependencyRegistrar接口，這一步非常關(guān)鍵，我們將要用的接口和實(shí)現(xiàn)類注入到容器中。

/// <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到倉儲(chǔ)
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. 配置文件中添加數(shù)據(jù)庫訪問節(jié)點(diǎn)

復(fù)制代碼 代碼如下:

<add name="test" connectionString="Data Source=.;Initial Catalog=MyProject;Integrated Security=False;Persist Security Info=False;User ID=sa;Password=sa1234" providerName="System.Data.SqlClient" />

　　4. 應(yīng)用啟動(dòng)時(shí)添加初始化引擎上下文

　　啟動(dòng)項(xiàng)目，這時(shí)NopEngine會(huì)報(bào)錯(cuò)，因?yàn)槲覀儧]有使用Nopconfig來配置項(xiàng)目，在RegisterDependencies方法中注釋NopConfig的注入，同時(shí)在Initialize過程中將相關(guān)代碼注釋。這樣就完成通過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，暫時(shí)注釋
//register mapper configurations
//RegisterMapperConfiguration(config);

 

//startup tasks 沒有啟用任務(wù)，注釋
//if (!config.IgnoreStartupTasks)
//{
// RunStartupTasks();
//}

 

}

　　5. 在controller添加測試代碼。將service添加到HomeController，在構(gòu)造函數(shù)中初始化。系統(tǒng)啟動(dòng)后會(huì)自動(dòng)注入實(shí)例。通過斷點(diǎn)我們看到，數(shù)據(jù)成功添加到了數(shù)據(jù)庫。

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 = "測試數(shù)據(jù)2"

};

_testService.InsertTest(entity);

var tests = _testService.GetAllTests();

return View();

}

五、擴(kuò)展到Webapi、Winform、WPF

　　現(xiàn)在再添加一個(gè)winform項(xiàng)目，同樣的步驟添加相關(guān)的代碼。在Winform中我們也能使用業(yè)務(wù)的服務(wù)了。

　　1. 通過Nuget安裝autofac,entityframework， 添加項(xiàng)目Libraries下的引用。

　　2. 添加依賴注冊類，因?yàn)槭莣inform項(xiàng)目，DependencyRegistrar這里需要做些調(diào)整，建議定義一個(gè)空接口IRegistrarForm，需要注入的Form實(shí)現(xiàn)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到倉儲(chǔ)
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. 在啟動(dòng)時(shí)添加 EngineContext.Initialize(false)，啟動(dòng)項(xiàng)目，報(bào)錯(cuò)了，因?yàn)閣inform不能執(zhí)行，對方法做些調(diào)整，添加一個(gè)參數(shù)isForm表示是否是winform，默認(rèn)為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>
/// 應(yīng)用程序的主入口點(diǎn)。

/// </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中測試，成功調(diào)用了業(yè)務(wù)層的方法，這里我們并沒有實(shí)例化ITestService，而是交給依賴注入自動(dòng)實(shí)現(xiàn)。

public partial class Form1 : Form, IRegistrarForm

{
private ITestService _testService;

public Form1(
ITestService testService

)

{

InitializeComponent();

_testService = testService;

//如果不注入form可以使用EngineContext.Current.Resolve<ITestService>(); 得到實(shí)例

}

 

private void button1_Click(object sender, EventArgs e)
{
var tests = _testService.GetAllTests();

}

}

感謝各位的閱讀！關(guān)于“基于nopCommerce開發(fā)框架的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識(shí)，如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到吧！