【SpringBoot应用篇】SpringBoot 业务代码中常用技巧

自定义拦截器
自定义过滤器
- 过滤器和拦截器的区别
文件上传虚拟路径设置
获取Spring容器对象
全局异常处理
类型转换器
参数解析器
@Import导入配置
生命周期钩子接口
自定义作用域
Spring事务声明式事务/编程式事务
- 声明式事务
- 编程式事务
@ConfigurationProperties+@EnableConfigurationProperties

自定义拦截器

Spring MVC拦截器跟Spring拦截器相比，它里面能够获取HttpServletRequest和HttpServletResponse等web对象实例。
Spring MVC拦截器的顶层接口是：HandlerInterceptor，包含三个方法：

preHandle()方法 - 用于在将请求发送到控制器之前执行操作。此方法应返回true，以将响应返回给客户端。
postHandle() 目标方法执行后执行
afterCompletion() 请求完成时执行

为了方便我们一般情况会用HandlerInterceptor接口的实现类HandlerInterceptorAdapter类。

拦截器应用场景:

登录验证，判断用户是否登录。
权限验证，判断用户是否有权限访问资源，如校验token
日志记录，记录请求操作日志（用户ip，访问时间等），以便统计请求访问量。
处理cookie、本地化、国际化、主题等。
性能监控，监控请求处理时长等。
通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现）

第一步，继承HandlerInterceptorAdapter类定义拦截器：

public class AuthInterceptor extends HandlerInterceptorAdapter {
    
    

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
    
    
        String requestUrl = request.getRequestURI();
        if (checkAuth(requestUrl)) {
    
    
            return true;
        }

        return false;
    }

    private boolean checkAuth(String requestUrl) {
    
    
        System.out.println("===权限校验===");
        return true;
    }
}

第二步，将该拦截器注册到Spring容器：

@Configuration
public class WebAuthConfig implements WebMvcConfigurer {
    
    
 
    @Bean
    public AuthInterceptor getAuthInterceptor() {
    
    
        return new AuthInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    
    
        registry.addInterceptor(getAuthInterceptor()).addPathPatterns("/**");
    }
}

自定义过滤器

过滤器是 Java Servlet 规范中定义的，它能够在请求传送给 Servlet 之前，对 ServletRequest 和 ServletResponse 做检查和修改，起到了过滤的作用。

过滤器应用场景:

过滤敏感词汇（防止sql注入）
设置字符编码
URL级别的权限访问控制
压缩响应信息

Spring Boot 中的过滤器是基于 Servlet 过滤器。第一步，定义过滤器的类，该类必须继承 Filter 接口。

public class MyFilter implements Filter  {
    
    
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
    
    
	}
 
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
    
    
		HttpServletRequest req = (HttpServletRequest) request;
		System.out.println("MyFilter: "+ req.getRequestURI());
		chain.doFilter(request, response);//这步使得请求能够继续传导下去，如果没有的话，请求就在此结束
	}
 
	@Override
	public void destroy() {
    
    
	
	}
}

第二步，注册过滤器，这步骤有 3 种方法。

方法 1. 在配置类中实现一个 FilterRegistrationBean 对象。

配置类实现方式

@Configuration
public class WebConfig {
    
    
	   @Bean
	   public FilterRegistrationBean<MyFilter> abcFilter() {
    
    
		   FilterRegistrationBean<MyFilter> filterRegBean = new FilterRegistrationBean<>();
		   filterRegBean.setFilter(new MyFilter());
		   filterRegBean.addUrlPatterns("/api/*");
		   filterRegBean.setOrder(Ordered.LOWEST_PRECEDENCE -1);
		   return filterRegBean;
	   }
}

方法 2. 使用`@Component 和@Order 注解注册。

使用@Component

@Order(Ordered.LOWEST_PRECEDENCE -1)
@Component
public class MyFilter implements Filter  {
    
    
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
    
    
		
	}
 
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
    
    
		HttpServletRequest req = (HttpServletRequest) request;
		System.out.println("MyFilter: "+ req.getRequestURI());
		chain.doFilter(request, response);//这步使得请求能够继续传导下去，如果没有的话，请求就在此结束
	}
 
	@Override
	public void destroy() {
    
    
	
	}
}

这种方法的缺点是不能再指定 UrlPatterns，默认的 URL 模式就是/*

方法 3. 使用@WebFilter 和@ServletComponentScan 注解，@WebFilter 注解是 Servlet3.0 中的注解，SpringBoot 能够支持该注解，通过@ServletComponentScan 注解，能够扫描并注册到 Servlet 容器中。

@WebFilter方式

@WebFilter(urlPatterns="/api/*")
public class MyFilter implements Filter  {
    
    
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
    
    
	}
 
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
    
    
		HttpServletRequest req = (HttpServletRequest) request;
		System.out.println("MyFilter: "+ req.getRequestURI());
		chain.doFilter(request, response);//这步使得请求能够继续传导下去，如果没有的话，请求就在此结束
	}
 
	@Override
	public void destroy() {
    
    
	
	}
}

还需要@ServletComponentScan 注解

@ServletComponentScan
@SpringBootApplication
public class SpringbootlearnApplication {
    
    
 
	public static void main(String[] args) {
    
    
		SpringApplication.run(SpringbootlearnApplication.class, args);
	}
}

@WebFilter 方式，可以支持 UrlPatterns 的设置，但是不支持 Order 的设置。

自定义过滤器解决XSS攻击和SQL注入

@Component
@ConfigurationProperties(prefix = "security")
@WebFilter(urlPatterns = "/*",asyncSupported = true)
@Order(1)
public class XssAndSqlFilter implements Filter {
    
    

    @Autowired
    @Qualifier("handlerExceptionResolver")
    private HandlerExceptionResolver resolver;

    /**
     * 是否启用
     */
    private boolean enable;
    /**
     * 忽略的URL
     */
    private List<String> excludes;


    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
    
    

        HttpServletRequest req = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;

        //跳过不需要的Xss校验的地址
        // 不启用或者已忽略的URL不拦截
        if (!enable || isExcludeUrl(req.getServletPath())) {
    
    
            filterChain.doFilter(servletRequest, servletResponse);
            return;
        }
        //注入xss过滤器实例
        XssAndSqlHttpServletRequestWrapper reqW = new XssAndSqlHttpServletRequestWrapper(req);
        try {
    
    
            //过滤
            filterChain.doFilter(reqW, response);
        } catch (Exception e) {
    
    
            resolver.resolveException(req, response, null, e);
        }
    }


    /**
     * 判断是否为忽略的URL
     *
     * @param url URL路径
     * @return true-忽略，false-过滤
     */
    private boolean isExcludeUrl(String url) {
    
    
        if (excludes == null || excludes.isEmpty()) {
    
    
            return false;
        }
        return excludes.stream().map(pattern -> Pattern.compile("^" + pattern)).map(p -> p.matcher(url)).anyMatch(Matcher::find);
    }


    public void setEnable(boolean enable) {
    
    
        this.enable = enable;
    }
    public void setExcludes(List<String> excludes) {
    
    
        this.excludes = excludes;
    }
}

public class XssAndSqlHttpServletRequestWrapper extends HttpServletRequestWrapper {
    
    

    private static final Logger log = LoggerFactory.getLogger(XssAndSqlHttpServletRequestWrapper.class);

    /**
     * post请求体
     */
    private byte[] body;

    /**
     * 是否是文件上传
     */
    private boolean fileUpload = false;

    /**
     * sql注入正则
     */
    private static String badStrReg =
            "\\b(and|or)\\b.{1,6}?(=|>|<|\\bin\\b|\\blike\\b)|\\/\\*.+?\\*\\/|<\\s*script\\b|\\bEXEC\\b|UNION.+?SELECT|UPDATE.+?SET|INSERT\\s+INTO.+?VALUES|(SELECT|DELETE).+?FROM|(CREATE|ALTER|DROP|TRUNCATE)\\s+(TABLE|DATABASE)";

    /**
     * xss脚本正则
     */
    private final static Pattern[] scriptPatterns = {
    
    
            Pattern.compile("<script>(.*?)</script>", Pattern.CASE_INSENSITIVE),
            Pattern.compile("src[\r\n]*=[\r\n]*\\\'(.*?)\\\'", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.DOTALL),
            Pattern.compile("</script>", Pattern.CASE_INSENSITIVE),
            Pattern.compile("<script(.*?)>", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.DOTALL),
            Pattern.compile("eval\\((.*?)\\)", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.DOTALL),
            Pattern.compile("expression\\((.*?)\\)", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.DOTALL),
            Pattern.compile("javascript:", Pattern.CASE_INSENSITIVE),
            Pattern.compile("vbscript:", Pattern.CASE_INSENSITIVE),
            Pattern.compile("onload(.*?)=", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.DOTALL)
    };


    /**
     * 构造器，将request传递给父类
     * @param request
     */
    public XssAndSqlHttpServletRequestWrapper(HttpServletRequest request) {
    
    
        super(request);
    }

    /**
     * 获取单个参数,将参数进行转义
     * @param name
     * @return
     */
    @Override
    public String getParameter(String name) {
    
    
        //获取参数
        String value = super.getParameter(name);
        if(!StrUtil.hasBlank(value)){
    
    
            //对参数进行转义
            value = cleanXSS(cleanSQLInject(value));
        }
        return value;
    }

    /**
     * 获取多个参数进行转义，返回值为数组
     * @param name
     * @return
     */
    @Override
    public String[] getParameterValues(String name) {
    
    
        //获取集合
        String[] values = super.getParameterValues(name);
        //判断集合是否为空，如果不为空，进行转义
        if(values != null){
    
    
            //遍历数组
            for(int i = 0;i < values.length;i++){
    
    
                String value = values[i];
                if(!StrUtil.hasBlank(value)){
    
    
                    //转义
                    value = cleanXSS(cleanSQLInject(value));
                }
                //将转义后的数据放回数组
                values[i] = value;
            }
        }
        return values;
    }

    /**
     * 获取请求头的数据，并进行转义
     * @param name
     * @return
     */
    @Override
    public String getHeader(String name) {
    
    
        String value =  super.getHeader(name);
        if(!StrUtil.hasBlank(value)){
    
    
            value = cleanXSS(cleanSQLInject(value));
        }
        return value;
    }

    /**
     * 获取Map参数
     * @return
     */
    @Override
    public Map<String, String[]> getParameterMap() {
    
    
        Map<String, String[]> parameterMap = super.getParameterMap();
        //因为super.getParameterMap()返回的是Map,所以我们需要定义Map的实现类对数据进行封装
        Map<String,String[]> params = new LinkedHashMap<>();
        //如果参数不为空
        if(parameterMap != null){
    
    
            //对map进行遍历
            for(String key:parameterMap.keySet()){
    
    
                //根据key获取value
                String[] values = parameterMap.get(key);
                //遍历数组
                for(int i = 0;i<values.length;i++){
    
    
                    String value = values[i];
                    if(!StrUtil.hasBlank(value)){
    
    
                        //转义
                        value = cleanXSS(cleanSQLInject(value));
                    }
                    //将转义后的数据放回数组中
                    values[i] = value;
                }
                //将转义后的数组put到linkMap当中
                params.put(key,values);
            }
        }
        return params;
    }

    /**
     * 获取@RequestBody输入流参数
     * @return
     * @throws IOException
     */
    @Override
    public ServletInputStream getInputStream() throws IOException {
    
    
        //获取输入流
        ServletInputStream in = super.getInputStream();
        //用于存储输入流
        StringBuffer body = new StringBuffer();
        InputStreamReader reader = new InputStreamReader(in, Charset.forName("UTF-8"));
        BufferedReader bufferedReader = new BufferedReader(reader);
        //按行读取输入流
        String line = bufferedReader.readLine();
        while(line != null){
    
    
            //将获取到的第一行数据append到StringBuffer中
            body.append(line);
            //继续读取下一行流，直到line为空
            line = bufferedReader.readLine();
        }
        //关闭流
        bufferedReader.close();
        reader.close();
        in.close();

        //将body转换为map
        Map<String,Object> map = JSONUtil.parseObj(body.toString());
        //创建空的map用于存储结果
        Map<String,Object> resultMap = new HashMap<>(map.size());
        //遍历数组
        for(String key:map.keySet()){
    
    
            Object value = map.get(key);
            //如果map.get(key)获取到的是字符串就需要进行转义，如果不是直接存储resultMap
            if(map.get(key) instanceof String){
    
    
                String str = cleanXSS(cleanSQLInject(value.toString()));
                resultMap.put(key,str);
            }else{
    
    
                resultMap.put(key,value);
            }
        }

        //将resultMap转换为json字符串
        String resultStr = JSONUtil.toJsonStr(resultMap);
        //将json字符串转换为字节
        final ByteArrayInputStream bis = new ByteArrayInputStream(resultStr.getBytes());

        //实现接口
        return new ServletInputStream() {
    
    
            @Override
            public boolean isFinished() {
    
    
                return false;
            }

            @Override
            public boolean isReady() {
    
    
                return false;
            }

            @Override
            public void setReadListener(ReadListener listener) {
    
    

            }

            @Override
            public int read() throws IOException {
    
    
                return bis.read();
            }
        };
    }


    /**
     * 清除xss
     * @param src 单个参数
     * @return
     */
    public String cleanXSS(String src) {
    
    
        String temp = src;
        // 校验xss脚本
        for (Pattern pattern : scriptPatterns) {
    
    
            temp = pattern.matcher(temp).replaceAll("");
        }
        // 校验xss特殊字符
        temp = temp.replaceAll("\0|\n|\r", "");
        temp = temp.replaceAll("<", "&lt;").replaceAll(">", "&gt;");

        if (!temp.equals(src)) {
    
    

            log.error("xss攻击检查：参数含有非法攻击字符，已禁止继续访问！！");
            log.error("原始输入信息-->" + src);

            throw new RuntimeException("xss攻击检查：参数含有非法攻击字符，已禁止继续访问！！");
        }

        return src;
    }

    /**
     * 过滤sql注入 -- 需要增加通配，过滤大小写组合
     * @param src 单个参数值
     * @return
     */
    public String cleanSQLInject(String src) {
    
    
        // 非法sql注入正则
        Pattern sqlPattern = Pattern.compile(badStrReg, Pattern.CASE_INSENSITIVE);
        if (sqlPattern.matcher(src.toLowerCase()).find()) {
    
    
            log.error("sql注入检查：输入信息存在SQL攻击！");
            throw new RuntimeException("sql注入检查：参数含有非法攻击字符，已禁止继续访问！！");
        }
        return src;
    }
}

# 信息安全,防止xxs跨站脚本攻击,SQL注入
security:
  enable: true
  excludes:

 <!--hutool工具类-->
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.4.0</version>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>2.0.1</version>
</dependency>
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.2.2</version>
</dependency>
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>1.3.2</version>
</dependency>

过滤器和拦截器的区别

在这里插入图片描述

1、过滤器和拦截器触发时机不一样，过滤器是在请求进入容器后，但请求进入servlet之前进行预处理的。请求结束返回也是，是在servlet处理完后，返回给前端之前。

2、拦截器可以获取IOC容器中的各个bean，而过滤器就不行，因为拦截器是Spring提供并管理的，Spring的功能可以被拦截器使用，在拦截器里注入一个service，可以调用业务逻辑。而过滤器是JavaEE标准，只需依赖servlet api ，不需要依赖Spring。

3、过滤器的实现基于回调函数。而拦截器（代理模式）的实现基于反射

4、Filter是依赖于Servlet容器，属于Servlet规范的一部分，而拦截器则是独立存在的，可以在任何情况下使用。

5、Filter的执行由Servlet容器回调完成，而拦截器通常通**过动态代理（反射）**的方式来执行。

6、Filter的生命周期由Servlet容器管理，而拦截器则可以通过IoC容器来管理，因此可以通过注入等方式来获取其他Bean的实例，因此使用会更方便。

文件上传虚拟路径设置

问题

在做文件上传是使用String path = ResourceUtils.getURL("classpath:").getPath();或者 String realPath = ClassUtils.getDefaultClassLoader().getResource("static").getPath();获取上传路径的时候是target目录下，也就是说，只要target目录没了，文件也就没了，这个是我们不想看到的。还有一种经常使用的方式就是直接将上传文件存到磁盘中，但是我们在前端却不能直接引用磁盘里的真实路径的文件，因为这个存在安全问题，所以这个时候，我们就要用web服务器来帮我们做一个虚拟映射，我们访问一个虚拟路径，其实访问的就是本机的真实路径，这样保证了安全性。
在这里插入图片描述

yml配置访问路径

file:
  ###静态资源对外暴露的访问路径
  staticAccessPath: /api/file/**
  ###静态资源实际存储路径
  uploadFolder: G:/staticResource/upload/

设置虚拟路径，访问绝对路径下资源

@Configuration
public class WebConfig  extends WebMvcConfigurerAdapter {
    
    

    @Value("${file.staticAccessPath}")
    private String staticAccessPath;
    @Value("${file.uploadFolder}")
    private String uploadFolder;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
    
    
        registry.addResourceHandler(staticAccessPath).addResourceLocations("file:" + uploadFolder);
    }
}

controller

@Value("${file.uploadFolder}")
private String uploadFolder;

@PostMapping("/project/upload/{id}")
public ResultVO<?> fileupload(MultipartFile file, HttpServletRequest req,@PathVariable Long id) throws FileNotFoundException {
    
    

    //使用UUID生成唯一标识文件名
    String randomNumber = UUID.randomUUID().toString().replace("-", "");
    //获取文件的原始名
    String oldFilename = file.getOriginalFilename();
    //获取文件后缀 .pdf
    String extension = oldFilename.substring(oldFilename.lastIndexOf("."));
    //生成新的文件名
    String newFileName = randomNumber + extension;

    File dateDir = new File(uploadFolder);

    if (!dateDir.exists()) {
    
    
        //判断目录是否存在，不存在则直接创建
        dateDir.mkdirs();
    }
    try {
    
    
        file.transferTo(new File(dateDir, newFileName));
    } catch (IOException e) {
    
    
        e.printStackTrace();
        return ResultVO.fail("上传失败");
    }
    
    //上传完毕，可以把上传地址保存到数据库或者直接返回前端显示
    String invented_address = req.getScheme()+"://"+req.getServerName()+":"+req.getServerPort() + "/api/file/" + newFileName;
	 
	 
    Project project = new Project();
    project.setId(id);
    project.setInterfaceDocUrl(invented_address);
    projectService.updateById(project);

    return ResultVO.ok("上传成功");
}

获取Spring容器对象

BeanFactoryAware接口

实现类必须是容器中的bean，否则无法获取容器对象ApplicationContext

@Component
public class SpringContextUtil<T> implements BeanFactoryAware {
    
    
    
    private BeanFactory beanFactory;

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
    
    
        this.beanFactory = beanFactory;
    }
    
    public T getBean(Class<T> clazz) {
    
    
       return beanFactory.getBean(clazz);
    }
}

实现BeanFactoryAware接口，然后重写setBeanFactory方法，就能从该方法中获取到Spring容器对象。

ApplicationContextAware接口

实现类必须是容器中的bean，否则无法获取容器对象ApplicationContext

@Component
public class SpringContextUtil2<T> implements ApplicationContextAware {
    
    

    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    
    
        this.applicationContext = applicationContext;
    }

    public T getBean(Class<T> clazz) {
    
    
        return applicationContext.getBean(clazz);
    }
}

实现ApplicationContextAware接口，然后重写setApplicationContext方法，也能从该方法中获取到Spring容器对象。

ApplicationListener接口

实现类必须是容器中的bean，否则无法获取容器对象ApplicationContext

@Component
public class SpringContextUtil3<T> implements ApplicationListener<ContextRefreshedEvent> {
    
    

    private ApplicationContext applicationContext;

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
    
    
        applicationContext = event.getApplicationContext();
    }


    public T getBean(Class<T> clazz) {
    
    
        return applicationContext.getBean(clazz);
    }
}

全局异常处理

以前我们在开发接口时，如果出现异常，为了给用户一个更友好的提示，例如：

@RestController
public class ExtController {
    
    
    @GetMapping("/add")
    public String add() {
    
    
        int a = 10 / 0;
        return "成功";
    }
}

如果不做任何处理请求add接口结果直接报错：

在这里插入图片描述

这种交互方式给用户的体验非常差，为了解决这个问题，我们通常会在接口中捕获异常：

@GetMapping("/add")
public String add() {
    
    
    String result = "成功";
    try {
    
    
        int a = 10 / 0;
    } catch (Exception e) {
    
    
        result = "数据异常";
    }
    return result;
}

接口改造后，出现异常时会提示：“数据异常”，对用户来说更友好。

如果只是一个接口还好，但是如果项目中有成百上千个接口，都要加上异常捕获代码吗？答案是否定的，这时全局异常处理就派上用场了：RestControllerAdvice。

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    

    @ExceptionHandler(Exception.class)
    public String handleException(Exception e) {
    
    
        if (e instanceof ArithmeticException) {
    
    
            return "数据异常";
        }
        if (e instanceof Exception) {
    
    
            return "服务器内部异常";
        }
        retur nnull;
    }
}

只需在handleException方法中处理异常情况，业务接口中可以放心使用，不再需要捕获异常（有人统一处理了）

类型转换器

Spring目前支持3中类型转换器：

Converter<S,T>：将 S 类型对象转为 T 类型对象
ConverterFactory<S, R>：将 S 类型对象转为 R 类型及子类对象
GenericConverter：它支持多个source和目标类型的转化，同时还提供了source和目标类型的上下文，这个上下文能让你实现基于属性上的注解或信息来进行类型转换。

这3种类型转换器使用的场景不一样，我们以Converter<S,T>为例。假如：接口中接收参数的实体对象中，有个字段的类型是Date，但是实际传参的是字符串类型：2023-01-03 10:20:15，要如何处理呢？

第一步，定义一个实体User：

@Data
public class User {
    
    

    private Long id;
    private String name;
    private Date registerDate;
}

第二步，实现Converter接口：

@Component
public class DateConverter implements Converter<String, Date> {
    
    

    private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public Date convert(String source) {
    
    
        if (source != null && !"".equals(source)) {
    
    
            try {
    
    
                simpleDateFormat.parse(source);
            } catch (ParseException e) {
    
    
                e.printStackTrace();
            }
        }
        return null;
    }
}

第三步，将新定义的类型转换器注入到Spring容器中：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    
	
    @Autowired
    private DateConverter dateConverter;
    
    @Override
    public void addFormatters(FormatterRegistry registry) {
    
    
        registry.addConverter(dateConverter);
    }
}

参数解析器

【SpringMVC应用篇】SpringMVC 参数解析器

@Import导入配置

有时我们需要在某个配置类中引入另外一些类，被引入的类也加到Spring容器中。这时可以使用@Import注解完成这个功能。

在这里插入图片描述

普通类

这种引入方式是最简单的，被引入的类会被实例化bean对象。

public class A {
    
    
}

@Import(A.class)
@Configuration
public class TestConfiguration {
    
    
}

通过@Import注解引入A类，Spring就能自动实例化A对象，然后在需要使用的地方通过@Autowired注解注入即可.

配置类

这种引入方式是最复杂的，因为@Configuration注解还支持多种组合注解，比如：

@Import
@ImportResource
@PropertySource

public class A {
    
    
}

public class B {
    
    
}

@Import(B.class)
@Configuration
public class AConfiguration {
    
    

    @Bean
    public A a() {
    
    
        return new A();
    }
}

@Import(AConfiguration.class)
@Configuration
public class TestConfiguration {
    
    
}

通过@Import注解引入@Configuration注解的配置类，会把该配置类相关@Import、@ImportResource、@PropertySource等注解引入的类进行递归，一次性全部引入。

ImportSelector

这种引入方式需要实现ImportSelector接口：

public class AImportSelector implements ImportSelector {
    
    

    private static final String CLASS_NAME = "cn.zysheep.service.A";

    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    
    
        return new String[]{
    
    CLASS_NAME};
    }
}

@Import(AImportSelector.class)
@Configuration
public class TestConfiguration {
    
    
}

这种方式的好处是selectImports方法返回的是数组，意味着可以同时引入多个类，还是非常方便的。

ImportBeanDefinitionRegistrar

这种引入方式需要实现ImportBeanDefinitionRegistrar接口：

public class AImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    
    
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    
    
        RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(A.class);
        registry.registerBeanDefinition("a", rootBeanDefinition);
    }
}

@Import(AImportBeanDefinitionRegistrar.class)
@Configuration
public class TestConfiguration {
    
    
}

这种方式是最灵活的，能在registerBeanDefinitions方法中获取到BeanDefinitionRegistry容器注册对象，可以手动控制BeanDefinition的创建和注册。

这四种引入类的方式各有千秋，总结如下：

普通类，用于创建没有特殊要求的bean实例。
@Configuration注解的配置类，用于层层嵌套引入的场景。
实现ImportSelector接口的类，用于一次性引入多个类的场景，或者可以根据不同的配置决定引入不同类的场景。
实现ImportBeanDefinitionRegistrar接口的类，主要用于可以手动控制BeanDefinition的创建和注册的场景，它的方法中可以获取BeanDefinitionRegistry注册容器对象。

生命周期钩子接口

初始化方法-InitializingBean

目前spring中使用比较多的初始化bean的方法有：

使用@PostConstruct注解
实现InitializingBean接口

方式一、在需要初始化的方法上增加@PostConstruct注解，这样就有初始化的能力。

@Service
public class AService {
    
    
    @PostConstruct
    public void init() {
    
    
        System.out.println("===初始化===");
    }
}

方式二、实现InitializingBean接口，重写afterPropertiesSet方法，该方法中可以完成初始化功能。

@Component
public class ConstantPropertiesUtils implements InitializingBean {
    
    
    
    @Value("${weixin.appid}")
    private String appid;

    @Value("${weixin.partner}")
    private String partner;

    @Value("${weixin.partnerkey}")
    private String partnerkey;

    public static String APPID;
    public static String PARTNER;
    public static String PARTNERKEY;
    @Override
    public void afterPropertiesSet() throws Exception {
    
    
        APPID = appid;
        PARTNER = partner;
        PARTNERKEY = partnerkey;
    }
}

修改BeanDefinition-BeanFactoryPostProcessor

Spring IOC在实例化Bean对象之前，需要先读取Bean的相关属性，保存到BeanDefinition对象中，然后通过BeanDefinition对象，实例化Bean对象。

如果想修改BeanDefinition对象中的属性，该怎么办呢？

答：我们可以实现BeanFactoryPostProcessor接口。

@Component
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    
    
    
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
    
    
        DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
        beanDefinitionBuilder.addPropertyValue("id", 123);
        beanDefinitionBuilder.addPropertyValue("name", "zysheep");
        defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
    }
}

在postProcessBeanFactory方法中，可以获取BeanDefinition的相关对象，并且修改该对象的属性。

初始化Bean前后-BeanPostProcessor

有时，你想在初始化Bean前后，实现一些自己的逻辑。

这时可以实现：BeanPostProcessor接口。

该接口目前有两个方法：

postProcessBeforeInitialization 该在初始化方法之前调用。
postProcessAfterInitialization 该方法再初始化方法之后调用。

@Component
public class MyBeanPostProcessor implements BeanPostProcessor {
    
    

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
    
    
        if (bean instanceof User) {
    
    
            ((User) bean).setUserName("zysheep");
        }
        return bean;
    }
}

如果spring中存在User对象，则将它的userName设置成：zysheep。

其实，我们经常使用的注解，比如：@Autowired、@Value、@Resource、@PostConstruct等，是通过AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor实现的。

Bean被IOC容器装配完成-CommandLineRunner

实现 CommandLineRunner接口的类会在bean被IOC容器装配完成之后（容器初始化完成后执行）被调用，适合预加载类及其它资源；也可以使用ApplicationRunner,使用方法及效果是一样的

好消息是springboot提供了：

CommandLineRunner
ApplicationRunner

这两个接口帮助我们实现以上需求。

它们的用法还是挺简单的，以ApplicationRunner接口为例：

@Component
public class TestRunner implements ApplicationRunner {
    
    

    @Autowired
    private LoadDataService loadDataService;

    public void run(ApplicationArguments args) throws Exception {
    
    
        loadDataService.load();
    }
}

实现ApplicationRunner接口，重写run方法，在该方法中实现自己定制化需求。

如果项目中有多个类实现了ApplicationRunner接口，他们的执行顺序要怎么指定呢？

答案是使用@Order(n)注解，n的值越小越先执行。当然也可以通过@Priority注解指定顺序。

关闭容器前-DisposableBean

有时候，我们需要在关闭spring容器前，做一些额外的工作，比如：关闭资源文件等。

这时可以实现DisposableBean接口，并且重写它的destroy方法：

@Service
public class DService implements InitializingBean, DisposableBean {
    
    
 
    @Override
    public void destroy() throws Exception {
    
    
        System.out.println("DisposableBean destroy");
    }
 
    @Override
    public void afterPropertiesSet() throws Exception {
    
    
        System.out.println("InitializingBean afterPropertiesSet");
    }
}

这样spring容器销毁前，会调用该destroy方法，做一些额外的工作。

通常情况下，我们会同时实现InitializingBean和DisposableBean接口，重写初始化方法和销毁方法。

自定义作用域

我们都知道Spring默认支持的Scope只有两种：

singleton 单例，每次从Spring容器中获取到的bean都是同一个对象。
prototype 多例，每次从Spring容器中获取到的bean都是不同的对象。

Spring web又对Scope进行了扩展，增加了：

RequestScope 同一次请求从Spring容器中获取到的bean都是同一个对象。
SessionScope 同一个会话从Spring容器中获取到的bean都是同一个对象。

即便如此，有些场景还是无法满足我们的要求。

比如，我们想在同一个线程中从Spring容器获取到的bean都是同一个对象，该怎么办？这就需要自定义Scope了。

第一步、实现Scope接口：

public class ThreadLocalScope implements Scope {
    
    
    private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();

    @Override
    public Object get(String name, ObjectFactory<?> objectFactory) {
    
    
        Object value = THREAD_LOCAL_SCOPE.get();
        if (value != null) {
    
    
            return value;
        }

        Object object = objectFactory.getObject();
        THREAD_LOCAL_SCOPE.set(object);
        return object;
    }

    @Override
    public Object remove(String name) {
    
    
        THREAD_LOCAL_SCOPE.remove();
        return null;
    }

    @Override
    public void registerDestructionCallback(String name, Runnable callback) {
    
    
    }

    @Override
    public Object resolveContextualObject(String key) {
    
    
        return null;
    }

    @Override
    public String getConversationId() {
    
    
        return null;
    }
}

第二步、将新定义的Scope注入到spring容器中：

@Component
public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    
    
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    
    
        beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());
    }
}

第三步、使用新定义的Scope：

@Scope("threadLocalScope")
@Service
public class CService {
    
    
    public void add() {
    
    
    }
}

Spring事务声明式事务/编程式事务

声明式事务

大多数情况下，我们在开发过程中使用更多的可能是声明式事务，即使用@Transactional注解定义的事务，因为它用起来更简单，方便。

只需在需要执行的事务方法上，加上@Transactional注解就能自动开启事务：

@Service
public class UserService {
    
    

    @Autowired
    private UserMapper userMapper;
    
    @Transactional
    public void add(UserModel userModel) {
    
    
        userMapper.insertUser(userModel);
    }
}

这种声明式事务之所以能生效，是因为它的底层使用了AOP，创建了代理对象，调用TransactionInterceptor拦截器实现事务的功能。

Spring事务有个特别的地方：它获取的数据库连接放在ThreadLocal中的，也就是说同一个线程中从始至终都能获取同一个数据库连接，可以保证同一个线程中多次数据库操作在同一个事务中执行。

正常情况下是没有问题的，但是如果使用不当，事务会失效，主要原因如下：

在这里插入图片描述

除了上述列举的问题之外，由于@Transactional注解最小粒度是要被定义在方法上，如果有多层的事务方法调用，可能会造成大事务问题。

在这里插入图片描述

编程式事务

一般情况下编程式事务我们可以通过TransactionTemplate类开启事务功能。有个好消息，就是SpringBoot已经默认实例化好这个对象了，我们能直接在项目中使用。

@Service
public class UserService {
    
    
   @Autowired
   private TransactionTemplate transactionTemplate;
   
   
   public void save(final User user) {
    
    
         transactionTemplate.execute((status) => {
    
    
            doSameThing...
            return Boolean.TRUE;
         })
   }
}

使用TransactionTemplate的编程式事务能避免很多事务失效的问题，但是对大事务问题，不一定能够解决，只是说相对于使用@Transactional注解要好些。

@ConfigurationProperties+@EnableConfigurationProperties

@EnableConfigurationProperties注解的作用是:让使用了 @ConfigurationProperties 注解的类生效,并且将该类注入到 IOC 容器中,交由 IOC 容器进行管理

实体类有了@EnableConfigurationProperties 注解之后该实体类就不需要加上 @Component 注解了

@Data
// @Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    
    

    //lastName必须是邮箱格式
    @Email
    private String lastName;
    private Integer age;
    private Boolean boss;
}

PersonController有了@EnableConfigurationProperties 注解之后该实体类就不需要加上 @Component 注解了

@RestController
@RequiredArgsConstructor
@EnableConfigurationProperties(Person.class)
public class PersonController {
    
    

    final Person person;

    @GetMapping("/getPerson")
    public String testProperties() {
    
    
        return person.toString();
    }
}

【SpringBoot应用篇】SpringBoot 业务代码中常用技巧

【SpringBoot应用篇】SpringBoot 业务代码中常用技巧

自定义拦截器

自定义过滤器

过滤器和拦截器的区别

文件上传虚拟路径设置

问题

yml配置访问路径

设置虚拟路径，访问绝对路径下资源

controller

获取Spring容器对象

BeanFactoryAware接口

ApplicationContextAware接口

ApplicationListener接口

全局异常处理

类型转换器

参数解析器

@Import导入配置

普通类

配置类

ImportSelector

ImportBeanDefinitionRegistrar

生命周期钩子接口

初始化方法-InitializingBean

修改BeanDefinition-BeanFactoryPostProcessor

初始化Bean前后-BeanPostProcessor

Bean被IOC容器装配完成-CommandLineRunner

关闭容器前-DisposableBean

自定义作用域

Spring事务声明式事务/编程式事务

声明式事务

编程式事务

@ConfigurationProperties+@EnableConfigurationProperties

猜你喜欢