假定一个场景,开始做开发的你,领导走到你的面前说道:“小伙子,看了简历和最近的工作表现,很不错,现在交给一个任务,开发一个简单的cms后端接口吧,前端有人配合你”,当时你内心读白:“cms什么东西,还好我可以百度,但我要在哪个项目上开搞啊”,这时的领导又说道:“项目你自己建立,然后上传git就行了”,这时的你是否已经石化,本篇文章就为您提供一个快速建立后端开发的模板,作者自己总结出品,如有不妥,指正即可。
模板代码下载:https://github.com/cqhaibin/apitemplate.git

目标

由于搭建的只是后端开发模板,主需要满足基本要求即可。

  • 框架结构简单
  • 数据库支持:mssql, mysql
  • 构架易于上手
  • 支持良好的业务扩展
  • 是一套基础开发模板

技术选型

  • 开发语言:c#
  • 运行时 .net framework4.5
  • ioc:autofac、autofac.webapi2
  • dto:automapper
  • 序列化:newtonsoft.json
  • orm:freesql
  • api:aspnet.webapi
  • 数据库:首先mssql、次先mysql
  • 缓存:基于list或dictionary实现单机内存级缓存

架构分层

  • 数据库访问层
    • freesql实体定义,也就是我们常说的是数据库实体
    • 提供dbcontext上下文的方式访问
    • 复杂的sql操作接口定义及实现,如:多表查询、存储过程执行等
  • 业务层
    • 业务层拆分两个项目,baccurate只做业务领域实体、值对象、系统配置对象、系统model对象、appservice的定义等定义;baccurate.implement领域业务的实现
    • baccurate.implement可以依赖baccurate.repository.fresql层,实现领域实体的数据持久化
    • feesql实体定义未放在baccurate层(业务规范项目),是为了防止领域实体与数据库实体混淆
    • baccurate项目可以被其他所有项目使用
  • 服务层
    • appservice.implement和webapi我都划分在服务层,其中webapi是一个贫血项目,只是把appservice做到webapi接口化
    • appservice的接口和model定义,都放到了baccurate(业务规范项目)中,方便后期对appservice的重写和扩展
  • ui层
    前端开发项目

接口规范

  • 接口以类resetful api规范返回
  • 返回结果规则一致
  • 接口名称前缀动词:get:表示查询;post:提交数据(添加/修改);delete:移除数据
  • 接口命名规则:接口名前缀+业务名称;以大驼峰命名
  • 接口要进行统一管理

部署规范

  • iis托管部署
  • 前端静态资源,托管到wwwroot目录