ASP.NET CORE API 第一篇 项目整体搭建 仓储+服务+抽象接口模式

原文作者：老张的哲学

零、完成图中的粉色部分

image.png

先简单解释下各层之间的调用关系：

除了项目对外暴露的是 Api 展示层，和核心的实体 Model 层外，

仓储模块（作为一个数据库管理员，直接操作数据库，实体模型）：

BaseRepository（基类仓储） 继承实现了 接口IBaseRepository，这里放公共的方法，
AdvertisementRepostitory 继承 BaseRepository<Advertisement>, IAdvertisementRepository

Service模块（处理业务逻辑，可以直接使用ViewModel视图模型）：

BaseService 调用 BaseRepository，同时继承 IBaseService
AdvertisementServices 继承 BaseServices<Advertisement>, IAdvertisementServices

一、创建实体Model数据层

image.png

其中，Models文件夹中，存放的是整个项目的数据库表实体类，这里是手动创建的，当然也可以自动创建，在以后的文章中我会提到，用到的是SqlSugar的T4创建，这里先埋一个伏笔。

提示：这个伏笔已经完成，地址《 三十二║ 四种方法快速实现项目的半自动化搭建》

然后，VeiwModels文件夹，是存放的DTO实体类，在开发中，一般接口需要接收数据，返回数据，我之前都是这么红果果的使用的，后来发现弊端很大，不仅把重要信息暴露出去（比如手机号等），还对数据造成冗余（比如我需要接收用户的生日，还需要具体的年、月、日这就是三个字段，当然您也可以手动拆开，这只是一个栗子，所以不能直接用数据库实体类接收），就用到了DTO类的转换，但是频繁的转换又会麻烦，别慌，以后的文章中，我们会引用AutoMapper来自动转换，这里再买一个伏笔。

提示：这个伏笔已经完成，地址《十三 || DTOs 对象映射使用》

最后的是MessageModel和TableModel，大家也基本一看就能明白，因为在前端接口中，需要固定的格式，以及操作，不能把数据直接发出去，会报错，在以后的Vue开发中，会提到这个，这里又买了一个伏笔。 如下：

 

/// <summary>
    /// 通用返回信息类
    /// </summary>
    public class MessageModel<T>
    {
        /// <summary>
        /// 操作是否成功
        /// </summary>
        public bool Success { get; set; }
        /// <summary>
        /// 返回信息
        /// </summary>
        public string Msg { get; set; }
        /// <summary>
        /// 返回数据集合
        /// </summary>
        public List<T> Data { get; set; }

    }

 

整个项目运行，没错，继续创建下一层。

二、设计仓储接口与其实现类

创建Blog.Core.IRepository和 Blog.Core.Repository 仓储层：

这里简单说下仓储层：repository就是一个管理数据持久层的，它负责数据的CRUD(Create, Read, Update, Delete) service layer是业务逻辑层，它常常需要访问repository层。有网友这么说：Repository（仓储）：协调领域和数据映射层，利用类似与集合的接口来访问领域对象。Repository 是一个独立的层，介于领域层与数据映射层（数据访问层）之间。它的存在让领域层感觉不到数据访问层的存在，它提供一个类似集合的接口提供给领域层进行领域对象的访问。Repository 是仓库管理员，领域层需要什么东西只需告诉仓库管理员，由仓库管理员把东西拿给它，并不需要知道东西实际放在哪。

 

image.png

我们定义了IRepository层，提供了所有的操作接口，今天搭建框架，我简单地写一个实例，明天我们将把所有的方法嵌套进去。
在 IAdvertisementRepository.cs 中，添加一个求和接口

namespace Blog.Core.IRespository
{
    public interface IAdvertisementRepository
    {
        int Sum(int i, int j);
    }
}

运行项目，一切正常，继续往下。

三、设计服务接口与其实现类

创建 Blog.Core.IServices 和 Blog.Core.Services 业务逻辑层，就是和我们平时使用的三层架构中的BLL层很相似：

 

image.png

Service层只负责将Repository仓储层的数据进行调用，至于如何是与数据库交互的，它不去管，这样就可以达到一定程度上的解耦，假如以后数据库要换，比如MySql，那Service层就完全不需要修改即可，至于真正意义的解耦，还是得靠依赖注入，这下一节我们会讲到。

这里在 IAdvertisementServices 中添加接口

 

namespace Blog.Core.IServices
{
    public interface IAdvertisementServices
    {
        int Sum(int i,int j);
    }
}

然后再在 AdvertisementServices 中去实现该接口

using Blog.Core.IServices;
using Blog.Core.IRespository;
using Blog.Core.Respository;

namespace Blog.Core.Services
{
    public class AdvertisementServices : IAdvertisementServices
    {
        IAdvertisementRepository dal = new AdvertisementRepository();
        public int Sum(int i, int j)
        {
            return dal.Sum(i, j);
        }
    }
}

注意！这里是引入了三个命名空间:

using Blog.Core.IServices;
using Blog.Core.IRespository;
using Blog.Core.Respository;

四、创建 Controller 接口调用

image.png

 

image.png

将系统默认的ValueController删除，手动添加一个BlogController控制器，可以选择一个空的，也可以选择一个带有默认读写实例的。如下：

 

using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;

namespace Blog.Core.API.Controllers
{
    [Produces("application/json")]
    [Route("api/[controller]")]
    [ApiController]
    public class BlogController : ControllerBase
    {
        // GET: api/Blog
        [HttpGet]
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        // GET: api/Blog/5
        [HttpGet("{id}", Name = "Get")]
        public string Get(int id)
        {
            return "value";
        }

        // POST: api/Blog
        [HttpPost]
        public void Post([FromBody] string value)
        {
        }

        // PUT: api/Blog/5
        [HttpPut("{id}")]
        public void Put(int id, [FromBody] string value)
        {
        }

        // DELETE: api/ApiWithActions/5
        [HttpDelete("{id}")]
        public void Delete(int id)
        {
        }
    }
}

接下来，在应用层添加服务层的引用

using Blog.Core.IServices;
using Blog.Core.Services;

然后，改写Get方法

        /// <summary>
        /// Sum接口
        /// </summary>
        /// <param name="i">参数i</param>
        /// <param name="j">参数j</param>
        /// <returns></returns>
        [HttpGet]
        public int Get(int i,int j)
        {
            IAdvertisementServices advertisementServices = new AdvertisementServices();
            return advertisementServices.Sum(i,j);
        }

F5 运行项目，调试如下：

 

image.png

天呀！出错辣！别慌，还记得昨天咱们加的权限么，嗯！就是那里，手动模拟登陆，获取Token，注入，不会的可以看上一篇，然后再执行，结果：

 

image.png

image.png

五、结语

好啦，今天的工作暂时到这里了，你可以看到整体项目的搭建，结构，如何引用，如何测试等，当然，这里还是有很多小问题，比如：

·如果每个仓储都需要这么写，至少是四遍，会不会太麻烦；

·每次Controller接口调用，需要引入很多命名空间

·等等等等

这些问题，下一节我们都会带大家一起去慢慢解决！