接上文
d1.framework.webapi 库是基础封装，每个 webapi 项目都必须使用，里面包含功能很多。
1. BaseApplication
所有业务项目的主入口 Application 类都需继承此类
@SpringBootApplication
public class DemoApplication extends BaseApplication{
}
这个类主要是增加几个缺省注解，比如激活 Swagger，确保对包进行扫描是从 d1 开始。
所以约定我们所有的业务项目的 package 都是 d1 开头，比如
d1.project.xxxx
@EnableSwagger2
@ComponentScan("d1")
@EntityScan("d1")
@EnableJpaRepositories("d1")
public class BaseApplication {
}
2. 封装 webapi 接口的返回 Result
所有 controller 返回的值都是一个 Result 对象，基本结构是
{
"code": 1,
"msg": "返回的消息,通常是字符串",
"data": "返回的数据，通常又是一个json对象"
}
使用方式：
return ResultUtil.result(10001,"自定义的消息",数据对象);
return ResultUtil.fail("自定义的消息",数据对象);
return ResultUtil.success("自定义的消息",数据对象);
3. ControllerAdvice
利用注解 @ControllerAdvice 实现统一拦截处理所有 controller 没有 catch 的错误
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ResponseBody
public Result all(Exception e) {
return ResultUtil.result(ResultCode.UN_CATCH_ERROR.code, e.getMessage(), e);
}
4. 封装Swagger自动生成API文档
只需要在 application.properties 配置文件里添加以下几个配置，业务项目的 API 文档就可以自动生成并以服务的方式来访问，访问的url是http://域名或地址/swagger-ui.html#/
#application.properties
d1.framework.webapi.swagger.enable=true #生产环境下通常改成false
d1.framework.webapi.swagger.title=项目的标题
d1.framework.webapi.swagger.desc=项目的描述
d1.framework.webapi.swagger.version=项目API的版本
d1.framework.webapi.swagger.host=www.xxxx.com:8089
在 contorller 里使用注解标记 API 的方法参考文档
4. 跨域设置
只需要在 application.properties 配置文件里添加以下配置，业务项目的前端页面可以实现跨域访问，当然生产环境的时候需要严格控制可跨域的域名。
#application.properties
#生成环境需要把*换成真实的域名，多个域名可以用逗号隔开
d1.framework.webapi.cors=*
5. BaseEntity
这是所有 Entity 的基类，主要是强行设置一个字段叫 Id，这个 Id 缺省是32位 uuid，在业务系统上建议所有 entity 都继承它。
6. User相关封装
DoUserBaseEntity 定义了用户表的常用字段，业务系统直接继承做一些扩展就可以了。
DoUserServiceImplBase 实现用户相关的 service，主要是创建 token，登录验证 token，缺省 token 都是用 d1.framework.cache 来缓存。
7. Auth相关
这里也是基于团队内部的一个约定，所有 webapi 接口如果需要验证权限，都需要在 http 请求的 header 里设置 Authorization 属性，属性的值有2种情况：
Authorization = token xxxxxxx 表示是通过用户登录后返回的 token 来验证
Authorization = sign xxxxxxx 表示服务间通过 HMAC 签名来校验
定义AuthFilter（继承Filter)来验证用户的请求Header里的Authoriztion对应的值如果是token的话，从d1.framework.cache里对应的缓存里查询token是否存在并是否没有过期。
另外通过定义一个自定义的注解Auth来设定web api接口是属于某种特定的用户。
@Auth("webadmin")
@RestController
@RequestMapping("/webadmin/user")
@Api(value = "/webadmin/user", description = "管理用户管理")
public class WebAdminUserController extends DoBaseController<WebAdminUser> {
......
}
@Auth("webadmin")标识这个controller里所有方法都必须是webadmin用户登录后才可以访问，这个注解也可以单独给特定方法使用
8. DestroyEhcacheBean
JVM 退出时先 shutdown ehcache，确保内存里的 cache 内容正确写入本地文件
public class DestroyEhcacheBean implements DisposableBean, ExitCodeGenerator {
......
@Override
public void destroy() throws Exception {
if (cache != null)
cache.shutDown();
}
}
9. DoServiceImpBase
包含 service 常用方法,其它 service 都继承这个方法，里面主要包括基本的增删改查，这是一个 abstract 方法，最主要是需要子类继承的时候返回一个实际的 dao 类。
这个基类还实现了根据 token 查询对应的用户对象。
public abstract class DoServiceImpBase<T> {
......
protected abstract JpaRepository<T, String> getDao();
......
}
10. DoBaseController类
controller 基类，封装了最基本的增删改查，子类只需要继承，常见的接口都已定义。
11. 日志
在项目的resource下有一个 logback.xml，没有特殊的需求的话，所有业务系统都可以用这个默认的日志配置。
另外定义了一个 LoggerController 实现通过 webapi 接口查看日志和下载日志文件，这样远程就可以查看日志。
12. HMACSignService
添加HMAC校验签名的基类service, 实现了服务间HMAC接口验证方式，规则参考微信的服务校验
13. SignInRetryLimitService
封装用户登录重试次数校验，超过一定次数将被锁住不能再试了。
需要在application.properties里添加2个配置：
#登录密码错误重试的次数，没有这个值或值为0表示不限制
d1.framework.webapi.sign-in.retry-count=5
#登录密码错误重试到一定次数后，锁住用户一段时间，单位是分钟
d1.framework.webapi.sign-in.lock-period=60
使用这个服务通过3个函数：
if (user == null) throw new Exception("用户：" + username + "不存在");
if (retryService.verifyIsLocked(username)) throw new Exception("用户重试错误密码多次，导致用户被锁");
if (!user.getPassword().equals(password)) {
retryService.signInWithWrongPwd(username);
throw new Exception("密码不对");
}
retryService.signInSuccess(username);
以上是 d1.framework.webapi 的基本功能，很多功能都是在开发实际项目的过程中逐渐添加上去的，包含的功能是杂七杂八的需求。
其它库都是针对特定的功能，这里不一一详述了。大家可以参考github。
网友评论