ASP.NET MVC 專案分層架構 Part.5 - 建立 Service 層

2014-12-02 補充說明：
這一系列的文章並不適合初階及中階的開發人員，如果你是程式開發的初學者或是 ASP.NET MVC 初學者，甚至是開發經驗少於兩年的開發人員，請馬上離開此篇文章。

這一篇距離上一篇「ASP.NET MVC 專案分層架構 Part.4 - 抽出 Model 層並建立為類別庫專案」相隔了好一段時間，除了說工作比較忙碌而沒有時間外，其實主要是為了這個系列的章節順序傷腦筋，因為想要先說其他的部份，但是如果不先說 Service 層的話，後續的章節也不見得會比較好寫，但寫了 Service 層會把之前的一些東西給推翻掉，怕會引起太多的反彈，內容就這樣反反覆覆，文章也寫得斷斷續續，最後還是決定先說明 Service 層。

看這一篇之前一定要先看過「分層架構」的 Part.1 ~ Part.4 這四篇文章。

 

---

什麼是 Service 層？

在 Repository 層裡，主要是用來操作資料的存取，例如應該要怎麼取得資料、取得多少的資料等，不牽涉商業邏輯的操作，而取得資料後的一些操作，例如訂單資料要去判斷訂單明細中貨品的存量是否可以出貨，像這樣的判斷處理並不適合放在 Repository 層之中，而 Repository 層為提供給 Service 層來使用。

Controller 其主要的工作為系統流程的控制，依據傳入的需求來決定要存取哪些資料，並且決定要選擇 View 以回應到需求端，資料的存取已經交給 Repository 做處理中，而商業邏輯的處理也不適合放在 Controller 當中，過多的商業邏輯處理反而會讓 Controller 的流程控制與商業邏輯混在一起，使得程式會越來越複雜且難以維護，此外就是不利於測試。

服務層，主要是把系統的商業邏輯給封裝起來，Service 層使用 Repository 層所提供的服務來存取資料， Controller 則是透過 Service 層來做資料的處理，而不直接使用 Repository。

 

Repository 還是 Service？

每個開發者的見解都不同，我的作法是，Repositiry 主要負責資料的 CRUD，而 Service 則是處理商業邏輯的處理。

 

建立 Service 層

我們在方案中建立一個 Service 的類別專案，

在 Service 專案裡我還是一樣會建立 Interface，所以建立 Interface 目錄來放置各個 Service 的 Interface，而 Service 專案會加入 Models 專案的參考，這樣才知道要存取什麼資料，

接著建立 interface，分別建立 ICategoryService.cs 與 IProductService.cs，至於介面的內容有些什麼呢？
基本上 Service 的 Interface 的定義會包含對物件的 CRUD，另外會依照各個 Model 的操作需要而建立其他的方法，如下：

ICategoryService.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Mvc_Repository.Models;

using Mvc_Repository.Service.Misc;

namespace Mvc_Repository.Service.Interface

{

    public interface ICategoryService

    {

        IResult Create(Categories instance);

        IResult Update(Categories instance);

        IResult Delete(int categoryID);

        bool IsExists(int categoryID);

        Categories GetByID(int categoryID);

        IEnumerable<Categories> GetAll();

    }

}

IProductService.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Mvc_Repository.Models;

using Mvc_Repository.Service.Misc;

namespace Mvc_Repository.Service.Interface

{

    public interface IProductService

    {

        IResult Create(Products instance);

        IResult Update(Products instance);

        IResult Delete(int productID);

        bool IsExists(int productID);

        Products GetByID(int productID);

        IEnumerable<Products> GetAll();

        IEnumerable<Products> GetByCategory(int categoryID);

    }

}

有看過「分層架構」前面四篇的人看了這個介面的定義後一定會有所懷疑甚至是不解，為什麼這兩個 Interface 的內容會跟 IRepository, ICategoryRepository, IProductRepository 的內容如此雷同，也可以說混合在一起了，為什麼要這麼做呢？

之前的作法是 Solution 內並沒有區分 Service 層，而對於資料的存取操作雖然是由 Repository 負責，但呼叫使用的卻是 Controller，我們是在 Controller 做了 Service 要做的事情，而一開始也有提到，Repository 是用來服務 Service 的，Repository 主要的工作是做資料存取，加入了 Service 層之後，原先在 ICategoryRepository 與 IProductRepository 內所定義的方法就不再需要了，連帶 CategoryRepository 與 ProductRepository 也不需要建立了，將這些工作交給 Service 來處理，Repository 就只保留 GenericRepository。

在兩個介面中的 Create, Update, Delete 所回傳的型別是 IResult，這是我自己建立的型別，用在執行後的結果訊息傳遞，

IResult.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace Mvc_Repository.Service.Misc

{

    public interface IResult

    {

        Guid ID

        {

            get;

        }

        bool Success

        {

            get;

            set;

        }

        string Message

        {

            get;

            set;

        }

        Exception Exception

        {

            get;

            set;

        }

        List<IResult> InnerResults

        {

            get;

        }

    }

}

Result.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace Mvc_Repository.Service.Misc

{

    public class Result : IResult

    {

        public Guid ID

        {

            get;

            private set;

        }

        public bool Success

        {

            get;

            set;

        }

        public string Message

        {

            get;

            set;

        }

        public Exception Exception

        {

            get;

            set;

        }

        public List<IResult> InnerResults

        {

            get;

            protected set;

        }

        public Result()

            : this(false)

        {

        }

        public Result(bool success)

        {

            ID = Guid.NewGuid();

            Success = success;

            InnerResults = new List<IResult>();

        }

    }

}

 

實作介面

CategoryService.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Mvc_Repository.Models;

using Mvc_Repository.Models.Interface;

using Mvc_Repository.Models.Repository;

using Mvc_Repository.Service.Interface;

using Mvc_Repository.Service.Misc;

namespace Mvc_Repository.Service

{

    public class CategoryService : ICategoryService

    {

        private IRepository<Categories> repository = new GenericRepository<Categories>();

        public IResult Create(Categories instance)

        {

            if (instance == null)

            {

                throw new ArgumentNullException();

            }

            IResult result = new Result(false);

            try

            {

                this.repository.Create(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public IResult Update(Categories instance)

        {

            if (instance == null)

            {

                throw new ArgumentNullException();

            }

            IResult result = new Result(false);

            try

            {

                this.repository.Update(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public IResult Delete(int categoryID)

        {

            IResult result = new Result(false);

            if (!this.IsExists(categoryID))

            {

                result.Message = "找不到資料";

            }

            try

            {

                var instance = this.GetByID(categoryID);

                this.repository.Delete(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public bool IsExists(int categoryID)

        {

            return this.repository.GetAll().Any(x => x.CategoryID == categoryID);

        }

        public Categories GetByID(int categoryID)

        {

            return this.repository.Get(x => x.CategoryID == categoryID);

        }

        public IEnumerable<Categories> GetAll()

        {

            return this.repository.GetAll();

        }

    }

}

ProductService.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Mvc_Repository.Models;

using Mvc_Repository.Models.Interface;

using Mvc_Repository.Models.Repository;

using Mvc_Repository.Service.Interface;

using Mvc_Repository.Service.Misc;

namespace Mvc_Repository.Service

{

    public class ProductService : IProductService

    {

        private IRepository<Products> repository = new GenericRepository<Products>();

        public Misc.IResult Create(Products instance)

        {

            if (instance == null)

            {

                throw new ArgumentNullException();

            }

            IResult result = new Result(false);

            try

            {

                this.repository.Create(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public IResult Update(Products instance)

        {

            if (instance == null)

            {

                throw new ArgumentNullException();

            }

            IResult result = new Result(false);

            try

            {

                this.repository.Update(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public IResult Delete(int productID)

        {

            IResult result = new Result(false);

            if (!this.IsExists(productID))

            {

                result.Message = "找不到資料";

            }

            try

            {

                var instance = this.GetByID(productID);

                this.repository.Delete(instance);

                result.Success = true;

            }

            catch (Exception ex)

            {

                result.Exception = ex;

            }

            return result;

        }

        public bool IsExists(int productID)

        {

            return this.repository.GetAll().Any(x => x.ProductID == productID);

        }

        public Products GetByID(int productID)

        {

            return this.repository.Get(x => x.ProductID == productID);

        }

        public IEnumerable<Products> GetAll()

        {

            return this.repository.GetAll();

        }

        public IEnumerable<Products> GetByCategory(int categoryID)

        {

            return this.repository.GetAll().Where(x => x.CategoryID == categoryID);

        }

    }

}

2013-05-29 更新說明：之前文章裡在 Repository 裡取得所有資料是使用 GetAll() 方法，而到了此篇文章卻改使用 Fetch()，其實兩種方法的程式都是一樣的，只是名稱不同，所以為了此系列文章的一致性，所以再改回使用 GetAll() 方法，感謝網友「amu607」的告知。

 

調整

完成了 Service 專案的建立與介面和實作之後，接下來就是要調整 Solution 的內容，首先要調整的就是 Repository 專案的內容，我們已經不需要 ICategoryRepository 與 IProductRepository 與其實作，所以就是把這些介面與實作從 Repository 專案中移除，

接下來就是調整 Web 專案，首先加入 Service 專案的參考，

再來就是修改 CategoryController 與 ProductController 的內容，因為之前是在 Controller 使用各個 model 的 repository，而現在都被移除之後，就改使用 CategoryService 與 ProductService。

 

CategoryController.cs

using System.Data;

using System.Linq;

using System.Web.Mvc;

using Mvc_Repository.Models;

using Mvc_Repository.Service;

using Mvc_Repository.Service.Interface;

namespace Mvc_Repository.Web.Controllers

{

    public class CategoryController : Controller

   {

        private ICategoryService categoryService;

        public CategoryController()

        {

            this.categoryService = new CategoryService();

        }

        //=========================================================================================

        public ActionResult Index()

        {

            var categories = this.categoryService.GetAll()

                .OrderByDescending(x => x.CategoryID)

                .ToList();

            return View(categories);

        }

        //=========================================================================================

        public ActionResult Details(int? id)

        {

            if (!id.HasValue)

            {

                return RedirectToAction("index");

            }

            else

            {

                var category = this.categoryService.GetByID(id.Value);

                return View(category);

            }

        }

        //=========================================================================================

        public ActionResult Create()

        {

            return View();

        }

        [HttpPost]

        public ActionResult Create(Categories category)

        {

            if (category != null && ModelState.IsValid)

            {

                this.categoryService.Create(category);

                return RedirectToAction("index");

            }

            else

            {

                return View(category);

            }

        }

        //=========================================================================================

        public ActionResult Edit(int? id)

        {

            if (!id.HasValue)

            {

                return RedirectToAction("index");

            }

            else

            {

                var category = this.categoryService.GetByID(id.Value);

                return View(category);

            }

        }

        [HttpPost]

        public ActionResult Edit(Categories category)

        {

            if (category != null && ModelState.IsValid)

            {

                this.categoryService.Update(category);

                return View(category);

            }

            else

            {

                return RedirectToAction("index");

            }

        }

        //=========================================================================================

        public ActionResult Delete(int? id)

        {

            if (!id.HasValue)

            {

                return RedirectToAction("index");

            }

            else

            {

                var category = this.categoryService.GetByID(id.Value);

                return View(category);

            }

        }

        [HttpPost, ActionName("Delete")]

        public ActionResult DeleteConfirmed(int id)

        {

            try

            {

                this.categoryService.Delete(id);

            }

            catch (DataException)

            {

                return RedirectToAction("Delete", new { id = id });

            }

            return RedirectToAction("index");

        }

    }

}

ProductController.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web.Mvc;

using Mvc_Repository.Models;

using Mvc_Repository.Service;

using Mvc_Repository.Service.Interface;

namespace Mvc_Repository.Web.Controllers

{

    public class ProductController : Controller

    {

        private IProductService productService;

        private ICategoryService categoryService;

        public IEnumerable<Categories> Categories

        {

            get

            {

                return categoryService.GetAll();

            }

        }

        public ProductController()

        {

            this.productService = new ProductService();

            this.categoryService = new CategoryService();

        }

        public ActionResult Index(string category = "all")

        {

            int categoryID = 1;

            ViewBag.CategorySelectList = int.TryParse(category, out categoryID)

                ? this.CategorySelectList(categoryID.ToString())

                : this.CategorySelectList("all");

            var result = category.Equals("all", StringComparison.OrdinalIgnoreCase)

                ? productService.GetAll()

                : productService.GetByCategory(categoryID);

            var products = result.OrderByDescending(x => x.ProductID).ToList();

            ViewBag.Category = category;

            return View(products);

        }

        [HttpPost]

        public ActionResult ProductsOfCategory(string category)

        {

            return RedirectToAction("Index", new { category = category });

        } 

        /// <summary>

        /// CategorySelectList

        /// </summary>

        /// <param name="selectedValue">The selected value.</param>

        /// <returns></returns>

        public List<SelectListItem> CategorySelectList(string selectedValue = "all")

        {

            List<SelectListItem> items = new List<SelectListItem>();

            items.Add(new SelectListItem()

            {

                Text = "All Category",

                Value = "all",

                Selected = selectedValue.Equals("all", StringComparison.OrdinalIgnoreCase)

            });

            var categories = categoryService.GetAll().OrderBy(x => x.CategoryID);

            foreach (var c in categories)

            {

                items.Add(new SelectListItem()

                {

                    Text = c.CategoryName,

                    Value = c.CategoryID.ToString(),

                    Selected = selectedValue.Equals(c.CategoryID.ToString())

                });

            }

            return items;

        }

        //=========================================================================================

        public ActionResult Details(int? id, string category)

        {

            if (!id.HasValue) return RedirectToAction("index");

            Products product = productService.GetByID(id.Value);

            if (product == null)

            {

                return HttpNotFound();

            }

            ViewBag.Category = string.IsNullOrWhiteSpace(category) ? "all" : category;

            return View(product);

        }

        //=========================================================================================

        public ActionResult Create(string category)

        {

            ViewBag.CategoryID = new SelectList(this.Categories, "CategoryID", "CategoryName");

            ViewBag.Category = string.IsNullOrWhiteSpace(category) ? "all" : category;

            return View();

        }

        [HttpPost]

        public ActionResult Create(Products products, string category)

        {

            if (ModelState.IsValid)

            {

                this.productService.Create(products);

                return RedirectToAction("Index", new { category = category });

            }

            ViewBag.CategoryID = new SelectList(this.Categories, "CategoryID", "CategoryName", products.CategoryID);

            return View(products);

        }

        //=========================================================================================

        public ActionResult Edit(int? id, string category)

        {

            if (!id.HasValue) return RedirectToAction("index");

            Products product = this.productService.GetByID(id.Value);

            if (product == null)

            {

                return HttpNotFound();

            }

            ViewBag.CategoryID = new SelectList(this.Categories, "CategoryID", "CategoryName", product.CategoryID);

            ViewBag.Category = string.IsNullOrWhiteSpace(category) ? "all" : category;

            return View(product);

        }

        [HttpPost]

        public ActionResult Edit(Products products, string category)

        {

            if (ModelState.IsValid)

            {

                this.productService.Update(products);

                return RedirectToAction("Index", new { category = category });

            }

            ViewBag.CategoryID = new SelectList(this.Categories, "CategoryID", "CategoryName", products.CategoryID);

            return View(products);

        }

        //=========================================================================================

        public ActionResult Delete(int? id, string category)

        {

            if (!id.HasValue) return RedirectToAction("index");

            Products product = this.productService.GetByID(id.Value);

            if (product == null)

            {

                return HttpNotFound();

            }

            ViewBag.Category = string.IsNullOrWhiteSpace(category) ? "all" : category;

            return View(product);

        }

        [HttpPost, ActionName("Delete")]

        public ActionResult DeleteConfirmed(int id, string category)

        {

            this.productService.Delete(id);

            return RedirectToAction("Index", new { category = category });

        }

    }

}

 

為什麼要捨棄原本建立的 repository 改使用 service 呢？

假如在 Controller 裡會慢慢地增加很多種方法，而這些方法越來越繁雜時，Controller 就會越來越難維護，Controller 除了原來的 Action 方法外還會有很多用來處理商業邏輯操作的方法存在，Controller 應該關注的是流程的控制、資料輸入與輸出的處理、決定回應需求要使用那一個 View，過多的商業邏輯處理方法同處在 Controller 裡，就破壞了「關注點分離」的原則，而這些商業邏輯的處理大多都會跟資料存取有關，那如果把這些方法都移往 repository 裡去，對於 repository 所扮演的角色與責任又會有所偏移。

repository 應該關注的是資料存取，不應該牽涉到商業邏輯的處理，所以這時候就需要加入 Service 層，這個 Service 層不需要關注資料怎麼處理，只需要知道資料存取是在哪裡，而其本身所關注的就是商業邏輯的處理。

將 Controller 的商業邏輯處理移往 Service 層，而原本依據各個 model 所建立的 repository 也就不需要存在，因為這部份的操作已經由 service 來處理，而各個 model 的 repository 就不需要個別建立，為了避免過多的資料存取方法的發散，在 service 裡是使用 GenricRepository 來處理資料的存取。

 

最後來看看調整後的架構，

 

 

2012-12-26 更新

補上 CodeMap 圖，讓希望能夠了解各層明確關連，

Mvc_Repository

Web 與 Models 的關聯在於 Model 資料與定義.

Web 與 Service 的關聯在於 controller 透過 service 來取得或更新 Model 資料.

Service 與 Models 的關聯在於 controller 使用 Models 的 Respository 來對資料進行存取操作.

Mvc_Repository.Web - Controller

Mvc_Repository.Service

Mvc_repository.Models

 

---

其實專案分層架構的建立順序與步驟不會如同分層架構的 Part.1 一直調整到 Part.5，如果真是這樣的話也會太累人了，通常都會先建立好 Model 的內容，然後建立 Repository，接著建立 Service，Model, Repository, Service 這幾個部分不會與表現層（Web）有直接的關係，所以進行網站的 Layout 設計或調整的同時，這幾個部分可以先進行實作，一方面也可以依據需求來做調整與修改，當基礎架構都設計到一個階段後，就可以進行網站雛形架構的實作，不必等到整個網站的 Layout 設計或是切版出來之後才做。

之前有人詢問有關於 ViewModel 在 Service 層之中是要怎麼處理的，因為這個問題不再分層架構的範疇下，有關 ViewModel 的說明，可以先參考不久前的文章「ASP.NET MVC 的 ViewModel - 基礎篇」，先對 ViewModel 有基本的認識後，日後會在另外的篇幅中做這部份的交代。

 

系列文章下一篇：

ASP.NET MVC 專案分層架構 Part.6 - DI/IoC 使用 Unity.MVC

 

延伸閱讀：

Huan-Lin 學習筆記

應用程式的分層設計 (1) - 入門範例

應用程式的分層設計 (2) - 一點改進

應用程式的分層設計 (3) - DDD、六角、與洋蔥架構

Repository，我可能不會用你

Repository，我可能不會用你 (2) - 範例

 

以上提供的文章所談論的架構與我所說明的架構有所不同，但對於專案的架構要如何規畫，每個層面各自做什麼處理，在這些文章中都有深入的說明，另外提醒的就是別忘了看文章後面的回應討論，那也是重點喔！

 

以上