当前位置:主页 > 查看内容

Spring中那些让你爱不释手的代码技巧

发布时间:2021-07-15 00:00| 位朋友查看

简介:前言 最近越来越多的读者认可我的文章,还是件挺让人高兴的事情。有些读者私信我说希望后面多分享spring方面的文章,这样能够在实际工作中派上用……

 前言

最近越来越多的读者认可我的文章,还是件挺让人高兴的事情。有些读者私信我说希望后面多分享spring方面的文章,这样能够在实际工作中派上用场。正好我对spring源码有过一定的研究,并结合我这几年实际的工作经验,把spring中我认为不错的知识点总结一下,希望对您有所帮助。

一 如何获取spring容器对象

1.实现BeanFactoryAware接口

  1. @Service  
  2. public  class PersonService implements BeanFactoryAware {  
  3.     private BeanFactory beanFactory;  
  4.     @Override  
  5.     public void setBeanFactory(BeanFactory beanFactory) throws BeansException {  
  6.         this.beanFactory = beanFactory;  
  7.     }  
  8.     public void add() {  
  9.         Person person = (Person) beanFactory.getBean("person");  
  10.     }  

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

2.实现ApplicationContextAware接口

  1. @Service  
  2. public  class PersonService2 implements ApplicationContextAware {  
  3.     private ApplicationContext applicationContext;  
  4.     @Override  
  5.     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {  
  6.         this.applicationContext = applicationContext;  
  7.     }  
  8.     public void add() {  
  9.         Person person = (Person) applicationContext.getBean("person");  
  10.     }  

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

3.实现ApplicationListener接口

  1. @Service  
  2. public  class PersonService3 implements ApplicationListener<ContextRefreshedEvent> {  
  3.     private ApplicationContext applicationContext;  
  4.     @Override  
  5.     public void onApplicationEvent(ContextRefreshedEvent event) {  
  6.         applicationContext = event.getApplicationContext();  
  7.     }  
  8.     public void add() {  
  9.         Person person = (Person) applicationContext.getBean("person");  
  10.     }  

实现ApplicationListener接口,需要注意的是该接口接收的泛型是ContextRefreshedEvent类,然后重写onApplicationEvent方法,也能从该方法中获取到spring容器对象。

此外,不得不提一下Aware接口,它其实是一个空接口,里面不包含任何方法。

它表示已感知的意思,通过这类接口可以获取指定对象,比如:

  •  通过BeanFactoryAware获取BeanFactory
  •  通过ApplicationContextAware获取ApplicationContext
  •  通过BeanNameAware获取BeanName等

Aware接口是很常用的功能,目前包含如下功能:

二 如何初始化bean

spring中支持3种初始化bean的方法:

  •  xml中指定init-method方法
  •  使用@PostConstruct注解
  •  实现InitializingBean接口

第一种方法太古老了,现在用的人不多,具体用法就不介绍了。

1.使用@PostConstruct注解

  1. @Service  
  2. public  class AService {  
  3.     @PostConstruct  
  4.     public void init() {  
  5.         System.out.println("===初始化===");  
  6.     }  

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

2.实现InitializingBean接口

  1. @Service  
  2. public  class BService implements InitializingBean {  
  3.     @Override  
  4.     public void afterPropertiesSet() throws Exception {  
  5.         System.out.println("===初始化===");  
  6.     }  

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

这里顺便抛出一个有趣的问题:init-method、PostConstruct 和 InitializingBean 的执行顺序是什么样的?

决定他们调用顺序的关键代码在AbstractAutowireCapableBeanFactory类的initializeBean方法中。

这段代码中会先调用BeanPostProcessor的postProcessBeforeInitialization方法,而PostConstruct是通过InitDestroyAnnotationBeanPostProcessor实现的,它就是一个BeanPostProcessor,所以PostConstruct先执行。

而invokeInitMethods方法中的代码:

决定了先调用InitializingBean,再调用init-method。

所以得出结论,他们的调用顺序是:

三 自定义自己的Scope

我们都知道spring默认支持的Scope只有两种:

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

spring web又对Scope进行了扩展,增加了:

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

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

比如,我们想在同一个线程中从spring容器获取到的bean都是同一个对象,该怎么办?

这就需要自定义Scope了。

第一步实现Scope接口:

  1. public  class ThreadLocalScope implements Scope {  
  2.     private  static  final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();  
  3.     @Override  
  4.     public Object get(String name, ObjectFactory<?> objectFactory) {  
  5.         Object value = THREAD_LOCAL_SCOPE.get();  
  6.         if (value != null) {  
  7.             return value; 
  8.          }  
  9.         Object object = objectFactory.getObject();  
  10.         THREAD_LOCAL_SCOPE.set(object);  
  11.         return object;  
  12.     }  
  13.     @Override  
  14.     public Object remove(String name) {  
  15.         THREAD_LOCAL_SCOPE.remove();  
  16.         return  null;  
  17.     } 
  18.     @Override  
  19.     public void registerDestructionCallback(String name, Runnable callback) {  
  20.     }   
  21.     @Override  
  22.     public Object resolveContextualObject(String key) {  
  23.         return  null;  
  24.     }  
  25.     @Override 
  26.      public String getConversationId() {  
  27.         return  null;  
  28.     }  

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

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

第三步使用新定义的Scope:

  1. @Scope("threadLocalScope")  
  2. @Service  
  3. public  class CService {  
  4.     public void add() {  
  5.     }  

四 别说FactoryBean没用

说起FactoryBean就不得不提BeanFactory,因为面试官老喜欢问它们的区别。

  •  BeanFactory:spring容器的顶级接口,管理bean的工厂。
  •  FactoryBean:并非普通的工厂bean,它隐藏了实例化一些复杂Bean的细节,给上层应用带来了便利。

如果你看过spring源码,会发现它有70多个地方在用FactoryBean接口。

上面这张图足以说明该接口的重要性,请勿忽略它好吗?

特别提一句:mybatis的SqlSessionFactory对象就是通过SqlSessionFactoryBean类创建的。

我们一起定义自己的FactoryBean:

  1. @Component  
  2. public  class MyFactoryBean implements FactoryBean {  
  3.     @Override  
  4.     public Object getObject() throws Exception {  
  5.         String data1 = buildData1();  
  6.         String data2 = buildData2();  
  7.         return buildData3(data1, data2);  
  8.     } 
  9.     private String buildData1() {  
  10.         return  "data1";  
  11.     }  
  12.     private String buildData2() {  
  13.         return  "data2";  
  14.     }  
  15.     private String buildData3(String data1, String data2) {  
  16.         return data1 + data2;  
  17.     }  
  18.     @Override  
  19.     public Class<?> getObjectType() {  
  20.         return  null;  
  21.     }  

获取FactoryBean实例对象:

  1. @Service  
  2. public  class MyFactoryBeanService implements BeanFactoryAware {  
  3.     private BeanFactory beanFactory;  
  4.     @Override  
  5.     public void setBeanFactory(BeanFactory beanFactory) throws BeansException {  
  6.         this.beanFactory = beanFactory;  
  7.     }  
  8.     public void test() {  
  9.         Object myFactoryBean = beanFactory.getBean("myFactoryBean");  
  10.         System.out.println(myFactoryBean);  
  11.         Object myFactoryBean1 = beanFactory.getBean("&myFactoryBean");  
  12.         System.out.println(myFactoryBean1);  
  13.     }  
  •  getBean("myFactoryBean");获取的是MyFactoryBeanService类中getObject方法返回的对象,
  •  getBean("&myFactoryBean");获取的才是MyFactoryBean对象。

五 轻松自定义类型转换

spring目前支持3中类型转换器:

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

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

第一步,定义一个实体User:

  1. @Data  
  2. public  class User {  
  3.     private Long id;  
  4.     private String name; 
  5.     private Date registerDate;  

第二步,实现Converter接口:

  1. public  class DateConverter implements Converter<String, Date> {  
  2.     private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
  3.     @Override  
  4.     public Date convert(String source) {  
  5.         if (source != null && !"".equals(source)) {  
  6.             try {  
  7.                 simpleDateFormat.parse(source);  
  8.             } catch (ParseException e) {  
  9.                 e.printStackTrace();  
  10.             }  
  11.         }  
  12.         return  null;  
  13.     }  

第三步,将新定义的类型转换器注入到spring容器中:

  1. @Configuration  
  2. public  class WebConfig extends WebMvcConfigurerAdapter {  
  3.     @Override  
  4.     public void addFormatters(FormatterRegistry registry) {  
  5.         registry.addConverter(new DateConverter());  
  6.     }  

第四步,调用接口

  1. @RequestMapping("/user")  
  2. @RestController  
  3. public  class UserController {  
  4.     @RequestMapping("/save")  
  5.     public String save(@RequestBody User user) {  
  6.         return  "success";  
  7.     }  

请求接口时User对象中registerDate字段会被自动转换成Date类型。

六 spring mvc拦截器,用过的都说好

spring mvc拦截器根spring拦截器相比,它里面能够获取HttpServletRequest和HttpServletResponse 等web对象实例。

spring mvc拦截器的顶层接口是:HandlerInterceptor,包含三个方法:

  •  preHandle 目标方法执行前执行
  •  postHandle 目标方法执行后执行
  •  afterCompletion 请求完成时执行

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

假如有权限认证、日志、统计的场景,可以使用该拦截器。

第一步,继承HandlerInterceptorAdapter类定义拦截器:

  1. public  class AuthInterceptor extends HandlerInterceptorAdapter {  
  2.     @Override  
  3.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  
  4.             throws Exception {  
  5.         String requestrequestUrl = request.getRequestURI();  
  6.         if (checkAuth(requestUrl)) {  
  7.             return  true;  
  8.         }  
  9.         return  false;  
  10.     }  
  11.     private boolean checkAuth(String requestUrl) {  
  12.         System.out.println("===权限校验===");  
  13.         return  true;  
  14.     }  

第二步,将该拦截器注册到spring容器:

  1. @Configuration  
  2. public  class WebAuthConfig extends WebMvcConfigurerAdapter {  
  3.     @Bean  
  4.     public AuthInterceptor getAuthInterceptor() {  
  5.         return  new AuthInterceptor();  
  6.     }  
  7.     @Override  
  8.     public void addInterceptors(InterceptorRegistry registry) {  
  9.         registry.addInterceptor(new AuthInterceptor()); 
  10.     }  

第三步,在请求接口时spring mvc通过该拦截器,能够自动拦截该接口,并且校验权限。

该拦截器其实相对来说,比较简单,可以在DispatcherServlet类的doDispatch方法中看到调用过程:

顺便说一句,这里只讲了spring mvc的拦截器,并没有讲spring的拦截器,是因为我有点小私心,后面就会知道。

七 Enable开关真香

不知道你有没有用过Enable开头的注解,比如:EnableAsync、EnableCaching、EnableAspectJAutoProxy等,这类注解就像开关一样,只要在@Configuration定义的配置类上加上这类注解,就能开启相关的功能。

是不是很酷?

让我们一起实现一个自己的开关:

第一步,定义一个LogFilter:

  1. public  class LogFilter implements Filter {  
  2.     @Override  
  3.     public void init(FilterConfig filterConfig) throws ServletException {  
  4.     }  
  5.     @Override  
  6.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {  
  7.         System.out.println("记录请求日志");  
  8.         chain.doFilter(request, response);  
  9.         System.out.println("记录响应日志");  
  10.     }  
  11.     @Override  
  12.     public void destroy() {    
  13.      }  

第二步,注册LogFilter:

  1. @ConditionalOnWebApplication  
  2. public  class LogFilterWebConfig {  
  3.     @Bean  
  4.     public LogFilter timeFilter() {  
  5.         return  new LogFilter();  
  6.     }  

注意,这里用了@ConditionalOnWebApplication注解,没有直接使用@Configuration注解。

第三步,定义开关@EnableLog注解:

  1. @Target(ElementType.TYPE)  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. @Documented  
  4. @Import(LogFilterWebConfig.class)  
  5. public @interface EnableLog {  

第四步,只需在springboot启动类加上@EnableLog注解即可开启LogFilter记录请求和响应日志的功能。

八 RestTemplate拦截器的春天

我们使用RestTemplate调用远程接口时,有时需要在header中传递信息,比如:traceId,source等,便于在查询日志时能够串联一次完整的请求链路,快速定位问题。

这种业务场景就能通过ClientHttpRequestInterceptor接口实现,具体做法如下:

第一步,实现ClientHttpRequestInterceptor接口:

  1. public  class RestTemplateInterceptor implements ClientHttpRequestInterceptor {  
  2.     @Override  
  3.     public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {  
  4.         request.getHeaders().set("traceId", MdcUtil.get());  
  5.         return execution.execute(request, body);  
  6.     }  

第二步,定义配置类:

  1. @Configuration  
  2. public  class RestTemplateConfiguration {  
  3.     @Bean  
  4.     public RestTemplate restTemplate() {  
  5.         RestTemplate restTemplate = new RestTemplate();  
  6.         restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));  
  7.         return restTemplate;  
  8.     }  
  9.     @Bean  
  10.     public RestTemplateInterceptor restTemplateInterceptor() {  
  11.         return  new RestTemplateInterceptor();  
  12.     }  

其中MdcUtil其实是利用MDC工具在ThreadLocal中存储和获取traceId

  1. public  class MdcUtil {  
  2.     private  static  final String TRACE_ID = "TRACE_ID" 
  3.     public static String get() {  
  4.         return MDC.get(TRACE_ID);  
  5.     }  
  6.     public static void add(String value) {  
  7.         MDC.put(TRACE_ID, value);  
  8.     }  

当然,这个例子中没有演示MdcUtil类的add方法具体调的地方,我们可以在filter中执行接口方法之前,生成traceId,调用MdcUtil类的add方法添加到MDC中,然后在同一个请求的其他地方就能通过MdcUtil类的get方法获取到该traceId。

九 统一异常处理

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

  1. @RequestMapping("/test")  
  2. @RestController  
  3. public  class TestController {  
  4.     @GetMapping("/add")  
  5.     public String add() {  
  6.         int a = 10 / 0;  
  7.         return  "成功";  
  8.     }  

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

what?用户能直接看到错误信息?

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

  1. @GetMapping("/add")  
  2. ublic String add() {  
  3.        String result = "成功" 
  4.        try {  
  5.            int a = 10 / 0;  
  6.        } catch (Exception e) {  
  7.            result = "数据异常" 
  8.        }  
  9.        return result; 

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

看起来挺不错的,但是有问题。。。

如果只是一个接口还好,但是如果项目中有成百上千个接口,都要加上异常捕获代码吗?

答案是否定的,这时全局异常处理就派上用场了:RestControllerAdvice。

  1. @RestControllerAdvice  
  2. public  class GlobalExceptionHandler {  
  3.     @ExceptionHandler(Exception.class)  
  4.     public String handleException(Exception e) {  
  5.         if (e instanceof ArithmeticException) {  
  6.             return  "数据异常";  
  7.         }  
  8.         if (e instanceof Exception) {  
  9.             return  "服务器内部异常";  
  10.         }  
  11.         retur n null;  
  12.     }  

只需在handleException方法中处理异常情况,业务接口中可以放心使用,不再需要捕获异常(有人统一处理了)。真是爽歪歪。

十 异步也可以这么优雅

以前我们在使用异步功能时,通常情况下有三种方式:

  •  继承Thread类
  •  实现Runable接口
  •  使用线程池

让我们一起回顾一下:

  1.  继承Thread类

  1. public  class MyThread extends Thread {  
  2.     @Override  
  3.     public void run() {  
  4.         System.out.println("===call MyThread===");  
  5.     }  
  6.     public static void main(String[] args) {  
  7.         new MyThread().start();  
  8.     }  

  2.  实现Runable接口

  1. public  class MyWork implements Runnable {  
  2.     @Override  
  3.     public void run() {  
  4.         System.out.println("===call MyWork===");  
  5.     }  
  6.     public static void main(String[] args) {  
  7.         new Thread(new MyWork()).start();  
  8.     }  

  3.  使用线程池

  1. public  class MyThreadPool {  
  2.     private  static ExecutorService executorService = new ThreadPoolExecutor(1, 5, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(200));  
  3.     static  class Work implements Runnable {  
  4.         @Override  
  5.         public void run() {  
  6.             System.out.println("===call work===");  
  7.         }  
  8.     } 
  9.     public static void main(String[] args) {  
  10.         try {  
  11.             executorService.submit(new MyThreadPool.Work());  
  12.         } finally {  
  13.             executorService.shutdown();  
  14.         }  
  15.     }  

这三种实现异步的方法不能说不好,但是spring已经帮我们抽取了一些公共的地方,我们无需再继承Thread类或实现Runable接口,它都搞定了。

如何spring异步功能呢?

第一步,springboot项目启动类上加@EnableAsync注解。

  1. @EnableAsync  
  2. @SpringBootApplication  
  3. public  class Application {  
  4.     public static void main(String[] args) {  
  5.         new SpringApplicationBuilder(Application.class).web(WebApplicationType.SERVLET).run(args);  
  6.     }  

第二步,在需要使用异步的方法上加上@Async注解:

  1. @Service  
  2. public  class PersonService {  
  3.     @Async  
  4.     public String get() {  
  5.         System.out.println("===add==");  
  6.         return  "data";  
  7.     }  

然后在使用的地方调用一下:personService.get();就拥有了异步功能,是不是很神奇。

默认情况下,spring会为我们的异步方法创建一个线程去执行,如果该方法被调用次数非常多的话,需要创建大量的线程,会导致资源浪费。

这时,我们可以定义一个线程池,异步方法将会被自动提交到线程池中执行。

  1. @Configuration  
  2. public  class ThreadPoolConfig {  
  3.     @Value("${thread.pool.corePoolSize:5}")  
  4.     private  int corePoolSize;  
  5.     @Value("${thread.pool.maxPoolSize:10}")  
  6.     private  int maxPoolSize;  
  7.     @Value("${thread.pool.queueCapacity:200}")  
  8.     private  int queueCapacity; 
  9.     @Value("${thread.pool.keepAliveSeconds:30}")  
  10.     private  int keepAliveSeconds;  
  11.     @Value("${thread.pool.threadNamePrefix:ASYNC_}")  
  12.     private String threadNamePrefix;  
  13.     @Bean  
  14.     public Executor MessageExecutor() {  
  15.         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();  
  16.         executor.setCorePoolSize(corePoolSize);  
  17.         executor.setMaxPoolSize(maxPoolSize);  
  18.         executor.setQueueCapacity(queueCapacity);  
  19.         executor.setKeepAliveSeconds(keepAliveSeconds);  
  20.         executor.setThreadNamePrefix(threadNamePrefix);  
  21.         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());  
  22.         executor.initialize();  
  23.         return executor;  
  24.     }  

spring异步的核心方法:

根据返回值不同,处理情况也不太一样,具体分为如下情况:

十一 听说缓存好用,没想到这么好用

spring cache架构图:

它目前支持多种缓存:

我们在这里以caffeine为例,它是spring官方推荐的。

第一步,引入caffeine的相关jar包

  1. <dependency>  
  2.     <groupId>org.springframework.boot</groupId>  
  3.     <artifactId>spring-boot-starter-cache</artifactId>  
  4. </dependency>  
  5. <dependency>  
  6.     <groupId>com.github.ben-manes.caffeine</groupId>  
  7.     <artifactId>caffeine</artifactId>  
  8.     <version>2.6.0</version>  
  9. </dependency> 

第二步,配置CacheManager,开启EnableCaching

  1. @Configuration  
  2. @EnableCaching  
  3. public  class CacheConfig {  
  4.     @Bean  
  5.     public CacheManager cacheManager(){  
  6.         CaffeineCacheManager cacheManager = new CaffeineCacheManager();  
  7.         //Caffeine配置  
  8.         Caffeine<Object, Object> caffeine = Caffeine.newBuilder()  
  9.                 //最后一次写入后经过固定时间过期  
  10.                 .expireAfterWrite(10, TimeUnit.SECONDS)  
  11.                 //缓存的最大条数  
  12.                 .maximumSize(1000);  
  13.         cacheManager.setCaffeine(caffeine);  
  14.         return cacheManager; 
  15.      }  

第三步,使用Cacheable注解获取数据

  1. @Service  
  2. public  class CategoryService {     
  3.    //category是缓存名称,#type是具体的key,可支持el表达式  
  4.    @Cacheable(value = "category"key = "#type" 
  5.    public CategoryModel getCategory(Integer type) {  
  6.        return getCategoryByType(type);  
  7.    }  
  8.    private CategoryModel getCategoryByType(Integer type) {  
  9.        System.out.println("根据不同的type:" + type + "获取不同的分类数据");  
  10.        CategoryModel categoryModel = new CategoryModel();  
  11.        categoryModel.setId(1L);  
  12.        categoryModel.setParentId(0L);  
  13.        categoryModel.setName("电器");  
  14.        categoryModel.setLevel(3);  
  15.        return categoryModel;  
  16.    }  

调用categoryService.getCategory()方法时,先从caffine缓存中获取数据,如果能够获取到数据则直接返回该数据,不会进入方法体。如果不能获取到数据,则直接方法体中的代码获取到数据,然后放到caffine缓存中。

【责任编辑:庞桂玉 TEL:(010)68476606】
本文转载自网络,原文链接:https://mp.weixin.qq.com/s/n8gHjDvJXc5GOryT3cYgtQ
本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐