SpringBoot常用技术总结

AOP

AOP(面向切面编程)允许开发人员将与业务逻辑无关的功能(例如日志记录、事务管理、安全性等)从应用程序的主要业务逻辑中分离出来,从而提高了代码的可维护性和可重用性。

使用:

1.导入 AOP 的maven坐标

org.aspectj

aspectjweaver

1.9.4

2.添加Aspect类,定义切点、通知:

@Aspect

@Component

public class GlobalInterceptor {

/**

* 定义切入点

*/

@Pointcut("@annotation(com.kkbpro.template.Annotation.RequestCheck)")

private void requestInterceptor() {

}

/**

* 环绕通知

*/

@Around("requestInterceptor()")

public Object DoInterceptor(ProceedingJoinPoint point) throws Throwable {

// 前置操作

Object obj = point.proceed(); // 执行方法

// 后置操作

return obj;

}

}

3.在需要AOP的方法上添加自定义注解:

@RequestCheck

public void aopDemo(String str) {

// 业务逻辑

}

CORS跨域

跨域请求指的是在浏览器中,从一个域名的网页向另一个域名的资源请求数据。

在传统的同源策略(Same-Origin Policy)下,浏览器限制了来自不同源(协议、域名、端口)的网页之间的交互。

添加允许跨域配置类:

import org.springframework.context.annotation.Configuration;

import javax.servlet.*;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.io.IOException;

@Configuration

public class CorsConfig implements Filter {

@Override

public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {

HttpServletResponse response = (HttpServletResponse) res;

HttpServletRequest request = (HttpServletRequest) req;

String origin = request.getHeader("Origin");

if(origin!=null) {

response.setHeader("Access-Control-Allow-Origin", origin);

}

String headers = request.getHeader("Access-Control-Request-Headers");

if(headers!=null) {

response.setHeader("Access-Control-Allow-Headers", headers);

response.setHeader("Access-Control-Expose-Headers", headers);

}

response.setHeader("Access-Control-Allow-Methods", "*");

response.setHeader("Access-Control-Max-Age", "3600");

response.setHeader("Access-Control-Allow-Credentials", "true");

chain.doFilter(request, response);

}

@Override

public void init(FilterConfig filterConfig) {

}

@Override

public void destroy() {

}

}

WebSocket

WebSocket 是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器全双工通信——浏览器和服务器只需要完成一次握手,两者之间就可以创建持久性的连接, 并进行双向数据传输。

WebSocket缺点:服务器长期维护长连接需要一定的成本、各个浏览器支持程度不一、WebSocket 是长连接,受网络限制比较大,需要处理好重连。

使用:

1.导入 WebSocket 的maven坐标

org.springframework.boot

spring-boot-starter-websocket

3.0.5

2.添加配置类WebSocketConfig,注册WebSocket的服务端组件

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration

public class WebSocketConfig {

@Bean

public ServerEndpointExporter serverEndpointExporter() {

return new ServerEndpointExporter();

}

}

3.添加WebSocket服务端组件WebSocketServer,用于和客户端通信

import org.springframework.stereotype.Component;

import javax.websocket.*;

import javax.websocket.server.PathParam;

import javax.websocket.server.ServerEndpoint;

@Component

@ServerEndpoint("/websocket/{info}") // 注意不要以'/'结尾

public class WebSocketServer {

@OnOpen

public void onOpen(Session session, @PathParam("info") String info) {

// 建立连接

}

@OnClose

public void onClose() {

// 关闭链接

}

@OnMessage

public void onMessage(String message, Session session) {

// 从Client接收消息

}

@OnError

public void onError(Session session, Throwable error) {

error.printStackTrace();

}

// 向客户端发送消息

public void sendMessage(Session session, String message) {

synchronized (session) {

try {

session.getBasicRemote().sendText(message);

} catch(IOException e) {

e.printStackTrace();

}

}

}

}

全局异常处理

通过配置全局异常处理,可以集中处理异常逻辑、统一异常返回格式、提高代码的可维护性和可读性、隐藏敏感信息等。

添加 GlobalExceptionHandler 类:

@RestControllerAdvice

public class GlobalExceptionHandler {

@ExceptionHandler(Exception.class) // 捕获运行时抛出的异常

public Result ex(Exception ex)

{

ex.printStackTrace();

return Result.error("操作失败,请联系管理员");

}

}

Swagger

使用Swagger后,我们只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。

官网:https://swagger.io/

knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

使用:

1.导入 knife4j 的maven坐标

com.github.xiaoymin

knife4j-spring-boot-starter

3.0.2

2.在配置类中加入 knife4j 相关配置

3.设置静态资源映射,否则接口文档页面无法访问

@Configuration

@Profile({"dev", "test"})

public class Knife4jConfig extends WebMvcConfigurationSupport {

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("doc.html")

.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");

}

@Bean

public Docket defaultApi2() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(new ApiInfoBuilder()

.title("后端接口文档")

.description("kkbpro-template")

.version("1.0")

.build())

.select()

// 指定 Controller 扫描包路径

.apis(RequestHandlerSelectors.basePackage("com.kkbpro.template.Controller"))

.paths(PathSelectors.any())

.build();

}

}

Spring Cache

Spring Cache 是一个框架,实现了基于注解的缓存功能,只需要简单地加一个注解,就能实现缓存功能。

Spring Cache 提供了一层抽象,底层可以切换不同的缓存实现,例如:EHCache、Caffeine、Redis

使用:

1.导入 Spring Cache 的maven坐标

org.springframework.boot

spring-boot-starter-cache

2.7.3

2.在启动类上加入 @EnableCaching 注解,开启缓存注解功能

3.在 Controller层的方法上加入相关注解:

注解说明@EnableCaching开启缓存注解功能,通常加在启动类上@Cacheable在方法执行前先查询缓存中是否有数据,如果有数据,则直接返回缓存数据;如果没有缓存数据,调用方法并将方法返回值放到缓存中@CachePut将方法的返回值放到缓存中@CacheEvict将一条或多条数据从缓存中删除

Spring Task

Spring Task 是Spring框架提供的任务调度工具,可以按照约定的时间自动执行某个代码逻辑。

应用场景:信用卡每月还款提醒、银行贷款每月还款提醒、火车票售票系统处理未支付订单、入职纪念日为用户发送通知

cron表达式:

cron表达式其实就是一个字符串,通过cron表达式可以定义任务触发的时间

构成规则:分为6或7个域,由空格分隔开,每个域代表一个含义

每个域的含义分别为:秒、分钟、小时、日、月、周、年(可选)

cron表达式在线生成器:https://cron.qqe2.com/

使用:

1.导入maven坐标 spring-context(已存在)

2.启动类添加注解 @EnableScheduling 开启任务调度

3.自定义定时任务类

@Scheduled(cron = "0 0 0 */1 * ?") // 每隔一天执行一次

private void reset() {

// 执行业务逻辑

}