spring boot集成swagger,自定义注解,拦截器,xss过滤,异步调用,guava限流,定时任务案例, 发邮件

时间:2024-01-08 13:25:32

本文介绍spring boot集成swagger,自定义注解,拦截器,xss过滤,异步调用,定时任务案例

集成swagger--对于做前后端分离的项目,后端只需要提供接口访问,swagger提供了接口调用测试和各种注释的可视化web界面。
配置swagger的扫描包路径,api信息等,见配置类SwaggerConfig。项目中遇到的下列注解都由swagger提供:
  @Api、@ApiOperation、@ApiModel、@ApiModelProperty
访问http://localhost/swagger-ui.html#/就可以看到swagger文档,输入入参,点击try it out调接口,如图:

spring boot集成swagger,自定义注解,拦截器,xss过滤,异步调用,guava限流,定时任务案例, 发邮件

自定义注解,拦截器,过滤器--spring boot提供了跨域请求的注解@CrossOrigin(当然也可以写一个全局的过滤器),详情见类UserController.class。
项目中XssFilter类定义了跨站脚本攻击(xss攻击)过滤,用到了ESAPI安全处理的jar包。
注解@LogForTimeConsumer实现了对方法的执行时间的日志输出;
注解@LogForController实现了view层出参和入参的日志输出;
注解@AutoValidate实现了对@RequestBody修饰的实体类(见类RegisterRequest.class)中属性的合法性的校验(即属性的正则表达式校验);
注解@AccessLimit实现了接口防刷的功能;
注解@TokenValidate实现了用户是否登录的校验,必须登录的接口加此注解;
拦截器RequestTimeConsumingInterceptor实现了接口耗时统计;
拦截器RepeatSubmitInterceptor实现了重复提交的校验;

拦截器RateLimitInterceptor实现了服务器访问的限流操作。

异步调用--UserController.class中注册接口提供了异步发送邮件的功能。只需要在异步调用的方法添加注解@Async和在启动类加注解@EnableAsync,
启动项目并调接口查看执行时间可以看到异步调用已经生效。

定时任务--启动类添加注解@EnableScheduling,用@Component放到定时任务的类上,@Scheduled放到定时任务的方法上就可以实现定时任务,见类TaskTest.class。

发邮件-EmailController.class;

项目源码地址:https://github.com/zhzhair/spirng-boot-demos.git