菜雞新訓記 (5): 使用 三層式架構 來切分服務的關注點和職責吧

[ApiController]
[Route("[controller]")]
public class CardController : ControllerBase
{
    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    [HttpGet]
    [Produces("application/json")]
    public IEnumerable<CardViewModel> GetList()
    {
        // 查詢卡片的一些操作
    }

    /// <summary>
    /// 查詢卡片
    /// </summary>     
    [HttpGet]
    [Produces("application/json")]
    [ProducesResponseType(typeof(CardViewModel), 200)]
    [Route("{id}")]
    public CardViewModel Get(
        [FromRoute] int id)
    {
        // 查詢指定 ID 的卡片的一些操作
    }

    /// <summary>
    /// 新增卡片
    /// </summary>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    [HttpPost]
    public IActionResult Insert(
        [FromBody] CardParameter parameter)
    {
        // 新增卡片的一些操作
    }

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    [HttpPut]
    [Route("{id}")]
    public IActionResult Update(
        [FromRoute] int id,
        [FromBody] CardParameter parameter)
    {
        // 更新卡片的一些操作
    }

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    [HttpDelete]
    [Route("{id}")]
    public IActionResult Delete(
        [FromRoute] int id)
    {
        // 刪除卡片的一些操作
    }
}

/// <summary>
/// 卡片
/// </summary>
public class CardViewModel
{
    /// <summary>
    /// 卡片編號
    /// </summary>
    public int Id { get; set; }

    /// <summary>
    /// 卡片名稱
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// 卡片描述
    /// </summary>
    public string Description { get; set; }

    /// <summary>
    /// 攻擊力
    /// </summary>
    public int Attack { get; set; }

    /// <summary>
    /// 血量
    /// </summary>
    public int Health { get; set; }

    /// <summary>
    /// 花費
    /// </summary>
    public int Cost { get; set; }
}

/// <summary>
/// 卡片參數
/// </summary>
public class CardParameter
{
    /// <summary>
    /// 卡片名稱
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// 卡片描述
    /// </summary>
    public string Description { get; set; }

    /// <summary>
    /// 攻擊力
    /// </summary>
    public int Attack { get; set; }

    /// <summary>
    /// 血量
    /// </summary>
    public int Health { get; set; }

    /// <summary>
    /// 花費
    /// </summary>
    public int Cost { get; set; }
}

/// <summary>
/// 卡片搜尋參數
/// </summary>
public class CardSearchParameter
{
    /// <summary>
    /// 卡片名稱
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// 攻擊力下限
    /// </summary>
    public int? MinAttack { get; set; }

    /// <summary>
    /// 攻擊力上限
    /// </summary>
    public int? MaxAttack { get; set; }

    /// <summary>
    /// 血量下限
    /// </summary>
    public int? MinHealth { get; set; }

    /// <summary>
    /// 血量上限
    /// </summary>
    public int? MaxHealth { get; set; }

    /// <summary>
    /// 花費值下限
    /// </summary>
    public int? MinCost { get; set; }

    /// <summary>
    /// 花費值上限
    /// </summary>
    public int? MaxCost { get; set; }
}

/// <summary>
/// 查詢卡片列表
/// </summary>
/// <returns></returns>
[HttpGet]
[Produces("application/json")]
public IEnumerable<CardViewModel> GetList(
    [FromQuery] CardSearchParameter parameter)
{
        // 查詢卡片的一些操作
}

/// <summary>
/// 卡片管理服務
/// </summary>
public interface ICardService
{

}

/// <summary>
/// 卡片管理服務
/// </summary>
public interface ICardService
{
    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    /// <returns></returns>
    IEnumerable<CardResultModel> GetList(CardSearchInfo info);

    /// <summary>
    /// 查詢卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>   
    CardResultModel Get(int id);

    /// <summary>
    /// 新增卡片
    /// </summary>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    bool Insert(CardInfo info);

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    bool Update(int id, CardInfo info);

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    bool Delete(int id);
}

// ProjectN.Service.Dtos.ResultModel
public class CardResultModel
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public int Attack { get; set; }
    public int Health { get; set; }
    public int Cost { get; set; }
}


// ProjectN.Service.Dtos.Info
public class CardInfo
{
    public string Name { get; set; }
    public string Description { get; set; }
    public int Attack { get; set; }
    public int Health { get; set; }
    public int Cost { get; set; }
}


// ProjectN.Service.Dtos.Info
public class CardSearchInfo
{
    public string Name { get; set; }
    public int? MinAttack { get; set; }
    public int? MaxAttack { get; set; }
    public int? MinHealth { get; set; }
    public int? MaxHealth { get; set; }
    public int? MinCost { get; set; }
    public int? MaxCost { get; set; }
}

/// <summary>
/// 卡片管理服務
/// </summary>
public interface ICardRepository
{
    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    /// <returns></returns>
    IEnumerable<CardDataModel> GetList(CardSearchCondition info);

    /// <summary>
    /// 查詢卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>   
    CardDataModel Get(int id);

    /// <summary>
    /// 新增卡片
    /// </summary>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    bool Insert(CardCondition info);

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    bool Update(int id, CardCondition info);

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    bool Delete(int id);
}

// ProjectN.Repository.Dtos.DataModel
public class CardDataModel
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public int Attack { get; set; }
    public int Health { get; set; }
    public int Cost { get; set; }
}


// ProjectN.Repository.Dtos.Condition
public class CardCondition
{
    public string Name { get; set; }
    public string Description { get; set; }
    public int Attack { get; set; }
    public int Health { get; set; }
    public int Cost { get; set; }
}


// ProjectN.Repository.Dtos.Condition
public class CardSearchCondition
{
    public string Name { get; set; }
    public int? MinAttack { get; set; }
    public int? MaxAttack { get; set; }
    public int? MinHealth { get; set; }
    public int? MaxHealth { get; set; }
    public int? MinCost { get; set; }
    public int? MaxCost { get; set; }
}

public class CardRepository : ICardRepository
{

}

public class CardRepository : ICardRepository
{
    public IEnumerable<CardDataModel> GetList(CardSearchCondition info)
    {
        throw new NotImplementedException();
    }

    public CardDataModel Get(int id)
    {
        throw new NotImplementedException();
    }
    
    public bool Insert(CardCondition info)
    {
        throw new NotImplementedException();
    }

    public bool Update(int id, CardCondition info)
    {
        throw new NotImplementedException();
    }
    
    public bool Delete(int id)
    {
        throw new NotImplementedException();
    }
}

/// <summary>
/// 卡片管理
/// </summary>
/// <seealso cref="ProjectN.Repository.Interface.ICardRepository" />
public class CardRepository : ICardRepository
{
    /// <summary>
    /// 連線字串
    /// </summary>
    private readonly string _connectString = @"Server=(LocalDB)\MSSQLLocalDB;Database=Newbie;Trusted_Connection=True;";

    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    /// <param name="info"></param>
    /// <returns></returns>
    public IEnumerable<CardDataModel> GetList(CardSearchCondition condition)
    {
        var sql = "SELECT * FROM Card";

        var sqlQuery = new List<string>();
        var parameter = new DynamicParameters();

        if (condition.MinCost.HasValue)
        {
            sqlQuery.Add($" Cost >= @MinCost ");
            parameter.Add("MinCost", condition.MinCost);
        }

        if (condition.MaxCost.HasValue)
        {
            sqlQuery.Add($" Cost <= @MaxCost ");
            parameter.Add("MaxCost", condition.MaxCost);
        }

        if (condition.MinAttack.HasValue)
        {
            sqlQuery.Add($" Attack >= @MinAttack ");
            parameter.Add("MinAttack", condition.MinAttack);
        }

        if (condition.MaxAttack.HasValue)
        {
            sqlQuery.Add($" Attack <= @MaxAttack ");
            parameter.Add("MaxAttack", condition.MaxAttack);
        }

        if (condition.MinHealth.HasValue)
        {
            sqlQuery.Add($" Health >= @MinHealth ");
            parameter.Add("MinHealth", condition.MinHealth);
        }

        if (condition.MaxHealth.HasValue)
        {
            sqlQuery.Add($" Health <= @MaxHealth ");
            parameter.Add("MaxHealth", condition.MaxHealth);
        }

        if (string.IsNullOrWhiteSpace(condition.Name) is false)
        {
            sqlQuery.Add($" Name LIKE @Name ");
            parameter.Add("Name", $"%{condition.Name}%");
        }
        
        if (sqlQuery.Any())
        {
            sql += $" WHERE {string.Join(" AND ", sqlQuery)} ";
        }

        using (var conn = new SqlConnection(_connectString))
        {
            var result = conn.Query<CardDataModel>(sql, parameter);
            return result;
        }
    }
	
    /// <summary>
    /// 查詢卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    public CardDataModel Get(int id)
    {
        var sql =
            @"		
                SELECT * 
                FROM Card 
                Where Id = @id
            ";

        var parameters = new DynamicParameters();
        parameters.Add("Id", id, System.Data.DbType.Int32);

        using (var conn = new SqlConnection(_connectString))
        {
            var result = conn.QueryFirstOrDefault<CardDataModel>(sql, parameters);
            return result;
        }
    }


    public bool Insert(CardCondition condition)
    {
        var sql =
            @"
                INSERT INTO Card 
                (
                   [Name]
                  ,[Description]
                  ,[Attack]
                  ,[Health]
                  ,[Cost]
                ) 
                VALUES 
                (
                    @Name
                   ,@Description
                   ,@Attack
                   ,@Health
                   ,@Cost
                );

                SELECT @@IDENTITY;
            ";

        using (var conn = new SqlConnection(_connectString))
        {
            var result = conn.Execute(sql, condition);
            return result > 0;
        }
    }

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="condition"></param>
    /// <returns></returns>
    public bool Update(int id, CardCondition condition)
    {
        var sql =
            @"
                UPDATE Card
                SET 
                    [Name] = @Name
                   ,[Description] = @Description
                   ,[Attack] = @Attack
                   ,[Health] = @Health
                   ,[Cost] = @Cost
                WHERE
                    Id = @id
            ";

        var parameters = new DynamicParameters();

        parameters.AddDynamicParams(condition);
        parameters.Add("Id", id, System.Data.DbType.Int32);

        using (var conn = new SqlConnection(_connectString))
        {
            var result = conn.Execute(sql, parameters);
            return result > 0;
        }
    }

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    public bool Delete(int id)
    {
        var sql =
            @"
                DELETE FROM Card
                WHERE Id = @Id
            ";

        var parameters = new DynamicParameters();
        parameters.Add("Id", id, System.Data.DbType.Int32);

        using (var conn = new SqlConnection(_connectString))
        {
            var result = conn.Execute(sql, parameters);
            return result > 0;
        }
    }
}

public class CardService : ICardService
{
    public IEnumerable<CardResultModel> GetList(CardSearchInfo info)
    {
        throw new NotImplementedException();
    }

    public CardResultModel Get(int id)
    {
        throw new NotImplementedException();
    }

    public bool Insert(CardInfo info)
    {
        throw new NotImplementedException();
    }

    public bool Update(int id, CardInfo info)
    {
        throw new NotImplementedException();
    }
    
    public bool Delete(int id)
    {
        throw new NotImplementedException();
    }
}

public class CardService : ICardService
{
    private readonly ICardRepository _cardRepository;

    /// <summary>
    /// 建構式
    /// </summary>
    public CardService()
    {
        this._cardRepository = new CardRepository();
    }

    // 其他實作部分
}

public class ServiceMappings : Profile
{
    public ServiceMappings()
    {
        // Info -> Condition
        this.CreateMap<CardInfo, CardCondition>();
        this.CreateMap<CardSearchInfo, CardSearchCondition>();

        // DataModel -> ResultModel
        this.CreateMap<CardDataModel, CardResultModel>();
    }
}

public class CardService : ICardService
{
    private readonly IMapper _mapper;
    private readonly ICardRepository _cardRepository;

    /// <summary>
    /// 建構式
    /// </summary>
    public CardService()
    {
        var config = new MapperConfiguration(cfg =>
			cfg.AddProfile<ServiceMappings>());

        this._mapper = config.CreateMapper();
        this._cardRepository = new CardRepository();
    }
    
    // 其他實作部分
}

/// <summary>
/// 查詢卡片列表
/// </summary>
/// <param name="info"></param>
/// <returns></returns>
public IEnumerable<CardResultModel> GetList(CardSearchInfo info)
{
    var condition = this._mapper.Map<CardSearchInfo, CardSearchCondition>(info);
    var data = this._cardRepository.GetList(condition);

    var result = this._mapper.Map<
        IEnumerable<CardDataModel>, 
    	IEnumerable<CardResultModel>>(data);

    return result;
}

/// <summary>
/// 卡片管理
/// </summary>
/// <seealso cref="ProjectN.Service.Interface.ICardService" />
public class CardService : ICardService
{
    private readonly IMapper _mapper;
    private readonly ICardRepository _cardRepository;

    /// <summary>
    /// 建構式
    /// </summary>
    public CardService()
    {
        this._cardRepository = new CardRepository();

        var config = new MapperConfiguration(cfg => 
			cfg.AddProfile<ServiceMappings>());

        this._mapper = config.CreateMapper();
    }

    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    /// <param name="info"></param>
    /// <returns></returns>
    public IEnumerable<CardResultModel> GetList(CardSearchInfo info)
    {
        var condition = this._mapper.Map<CardSearchInfo, CardSearchCondition>(info);
        var cards = this._cardRepository.GetList(condition);

        var result = this._mapper.Map<
            IEnumerable<CardDataModel>, 
        	IEnumerable<CardResultModel>>(cards);

        return result;
    }

    /// <summary>
    /// 查詢卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    public CardResultModel Get(int id)
    {
        var card = this._cardRepository.Get(id);
        var result = this._mapper.Map<CardDataModel, CardResultModel>(card);
        return result;
    }

    /// <summary>
    /// 新增卡片
    /// </summary>
    /// <param name="info"></param>
    /// <returns></returns>
    public bool Insert(CardInfo info)
    {
        var condition = this._mapper.Map<CardInfo, CardCondition>(info);
        var result = this._cardRepository.Insert(condition);
        return result;
    }

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="info"></param>
    /// <returns></returns>
    public bool Update(int id, CardInfo info)
    {
        var condition = this._mapper.Map<CardInfo, CardCondition>(info);
        var result = this._cardRepository.Update(id, condition);
        return result;
    }

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    public bool Delete(int id)
    {
        var result = this._cardRepository.Delete(id);
        return result;
    }
}

public class ControllerMappings : Profile
{
    public ControllerMappings()
    {
        // Parameter -> Info
        this.CreateMap<CardParameter, CardInfo>();
        this.CreateMap<CardSearchParameter, CardSearchInfo>();

        // ResultModel -> ViewModel
        this.CreateMap<CardResultModel, CardViewModel>();
    }
}

/// <summary>
/// 卡片管理
/// </summary>
/// <seealso cref="Microsoft.AspNetCore.Mvc.ControllerBase" />
[ApiController]
[Route("[controller]")]
public class CardController : ControllerBase
{
    private readonly IMapper _mapper;
    private readonly ICardService _cardService;

    /// <summary>
    /// 建構式
    /// </summary>
    public CardController()
    {
        var config = new MapperConfiguration(cfg =>
        	cfg.AddProfile<ControllerMappings>());

        this._mapper = config.CreateMapper();
        this._cardService = new CardService();
    }

    /// <summary>
    /// 查詢卡片列表
    /// </summary>
    /// <returns></returns>
    [HttpGet]
    [Produces("application/json")]
    public IEnumerable<CardViewModel> GetList(
        [FromQuery] CardSearchParameter parameter)
    {
        var info = this._mapper.Map<
            CardSearchParameter, 
        	CardSearchInfo>(parameter);

        var cards = this._cardService.GetList(info);

        var result = this._mapper.Map<
            IEnumerable<CardResultModel>,
        	IEnumerable<CardViewModel>>(cards);

        return result;
    }

    /// <summary>
    /// 查詢卡片
    /// </summary>
    /// <remarks>我是附加說明</remarks>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    /// <response code="200">回傳對應的卡片</response>
    /// <response code="404">找不到該編號的卡片</response>          
    [HttpGet]
    [Produces("application/json")]
    [ProducesResponseType(typeof(CardViewModel), 200)]
    [Route("{id}")]
    public CardViewModel Get(
        [FromRoute] int id)
    {
        var card = this._cardService.Get(id);

        var result = this._mapper.Map<
            CardResultModel,
        	CardViewModel>(card);

        return result;
    }

    /// <summary>
    /// 新增卡片
    /// </summary>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    [HttpPost]
    public IActionResult Insert(
        [FromBody] CardParameter parameter)
    {
        var info = this._mapper.Map<
            CardParameter,
        	CardInfo>(parameter);

        var isInsertSuccess = this._cardService.Insert(info);
        if (isInsertSuccess)
        {
            return Ok();
        }
        return StatusCode(500);
    }

    /// <summary>
    /// 更新卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <param name="parameter">卡片參數</param>
    /// <returns></returns>
    [HttpPut]
    [Route("{id}")]
    public IActionResult Update(
        [FromRoute] int id,
        [FromBody] CardParameter parameter)
    {
        var targetCard = this._cardService.Get(id);
        if (targetCard is null)
        {
            return NotFound();
        }

        var info = this._mapper.Map<
            CardParameter,
        	CardInfo>(parameter);

        var isUpdateSuccess = this._cardService.Update(id, info);
        if (isUpdateSuccess)
        {
            return Ok();
        }
        return StatusCode(500);
    }

    /// <summary>
    /// 刪除卡片
    /// </summary>
    /// <param name="id">卡片編號</param>
    /// <returns></returns>
    [HttpDelete]
    [Route("{id}")]
    public IActionResult Delete(
        [FromRoute] int id)
    {
        this._cardService.Delete(id);
        return Ok();
    }
}