Spring中的這些能技巧，越早知道越好！

前言

最近越來越多的讀者認可我的文章，還是件挺讓人高興的事情。有些讀者私信我說希望後面多分享spring方面的文章，這樣能夠在實際工作中派上用場。正好我對spring源碼有過一定的研究，並結合我這幾年實際的工作經驗，把spring中我認爲不錯的知識點總結一下，希望對您有所幫助。

一如何獲取spring容器對象

1.實現BeanFactoryAware接口

@Service
public  class PersonService implements BeanFactoryAware {
    private BeanFactory beanFactory;

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        this.beanFactory = beanFactory;
    }

    public void add() {
        Person person = (Person) beanFactory.getBean("person");
    }
}

實現BeanFactoryAware接口，然後重寫setBeanFactory方法，就能從該方法中獲取到spring容器對象。

2.實現ApplicationContextAware接口

@Service
public  class PersonService2 implements ApplicationContextAware {
    private ApplicationContext applicationContext;

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

    public void add() {
        Person person = (Person) applicationContext.getBean("person");
    }

}

實現ApplicationContextAware接口，然後重寫setApplicationContext方法，也能從該方法中獲取到spring容器對象。

3.實現ApplicationListener接口

@Service
public  class PersonService3 implements ApplicationListener<ContextRefreshedEvent> {
    private ApplicationContext applicationContext;


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

    public void add() {
        Person person = (Person) applicationContext.getBean("person");
    }

}

實現ApplicationListener接口，需要注意的是該接口接收的泛型是ContextRefreshedEvent類，然後重寫onApplicationEvent方法，也能從該方法中獲取到spring容器對象。

此外，不得不提一下Aware接口，它其實是一個空接口，裏面不包含任何方法。

它表示已感知的意思，通過這類接口可以獲取指定對象，比如：

通過BeanFactoryAware獲取BeanFactory
通過ApplicationContextAware獲取ApplicationContext
通過BeanNameAware獲取BeanName等

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

二如何初始化bean

spring中支持3種初始化bean的方法：

xml中指定init-method方法
使用@PostConstruct註解
實現InitializingBean接口

第一種方法太古老了，現在用的人不多，具體用法就不介紹了。

1.使用@PostConstruct註解

@Service
public  class AService {

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

在需要初始化的方法上增加@PostConstruct註解，這樣就有初始化的能力。

2.實現InitializingBean接口

@Service
public  class BService implements InitializingBean {

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("===初始化===");
    }
}

實現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接口：

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() {
    }
}

四別說FactoryBean沒用

說起FactoryBean就不得不提BeanFactory，因爲面試官老喜歡問它們的區別。

BeanFactory：spring容器的頂級接口，管理bean的工廠。
FactoryBean：並非普通的工廠bean，它隱藏了實例化一些複雜Bean的細節，給上層應用帶來了便利。

如果你看過spring源碼，會發現它有70多個地方在用FactoryBean接口。

上面這張圖足以說明該接口的重要性，請勿忽略它好嗎？

特別提一句：mybatis的SqlSessionFactory對象就是通過SqlSessionFactoryBean類創建的。

我們一起定義自己的FactoryBean：

@Component
public  class MyFactoryBean implements FactoryBean {

    @Override
    public Object getObject() throws Exception {
        String data1 = buildData1();
        String data2 = buildData2();
        return buildData3(data1, data2);
    }

    private String buildData1() {
        return  "data1";
    }

    private String buildData2() {
        return  "data2";
    }

    private String buildData3(String data1, String data2) {
        return data1 + data2;
    }


    @Override
    public Class<?> getObjectType() {
        return  null;
    }
}

獲取FactoryBean實例對象：

@Service
public  class MyFactoryBeanService implements BeanFactoryAware {
    private BeanFactory beanFactory;

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        this.beanFactory = beanFactory;
    }

    public void test() {
        Object myFactoryBean = beanFactory.getBean("myFactoryBean");
        System.out.println(myFactoryBean);
        Object myFactoryBean1 = beanFactory.getBean("&myFactoryBean");
        System.out.println(myFactoryBean1);
    }
}

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：

@Data
public  class User {

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

第二步，實現Converter接口：

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 extends WebMvcConfigurerAdapter {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new DateConverter());
    }
}

第四步，調用接口

@RequestMapping("/user")
@RestController
public  class UserController {

    @RequestMapping("/save")
    public String save(@RequestBody User user) {
        return  "success";
    }
}

請求接口時User對象中registerDate字段會被自動轉換成Date類型。

六 spring mvc攔截器，用過的都說好

spring mvc攔截器根spring攔截器相比，它裏面能夠獲取HttpServletRequest和HttpServletResponse 等web對象實例。

spring mvc攔截器的頂層接口是：HandlerInterceptor，包含三個方法：

preHandle 目標方法執行前執行
postHandle 目標方法執行後執行
afterCompletion 請求完成時執行

爲了方便我們一般情況會用HandlerInterceptor接口的實現類HandlerInterceptorAdapter類。

假如有權限認證、日誌、統計的場景，可以使用該攔截器。

第一步，繼承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 extends WebMvcConfigurerAdapter {
 
    @Bean
    public AuthInterceptor getAuthInterceptor() {
        return  new AuthInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthInterceptor());
    }
}

第三步，在請求接口時spring mvc通過該攔截器，能夠自動攔截該接口，並且校驗權限。

該攔截器其實相對來說，比較簡單，可以在DispatcherServlet類的doDispatch方法中看到調用過程：

順便說一句，這裏只講了spring mvc的攔截器，並沒有講spring的攔截器，是因爲我有點小私心，後面就會知道。

七 Enable開關真香

不知道你有沒有用過Enable開頭的註解，比如：EnableAsync、EnableCaching、EnableAspectJAutoProxy等，這類註解就像開關一樣，只要在@Configuration定義的配置類上加上這類註解，就能開啓相關的功能。

是不是很酷？

讓我們一起實現一個自己的開關：

第一步，定義一個LogFilter：

public  class LogFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("記錄請求日誌");
        chain.doFilter(request, response);
        System.out.println("記錄響應日誌");
    }

    @Override
    public void destroy() {
        
    }
}

第二步，註冊LogFilter：

@ConditionalOnWebApplication
public  class LogFilterWebConfig {

    @Bean
    public LogFilter timeFilter() {
        return  new LogFilter();
    }
}

注意，這裏用了@ConditionalOnWebApplication註解，沒有直接使用@Configuration註解。

第三步，定義開關@EnableLog註解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(LogFilterWebConfig.class)
public @interface EnableLog {

}

第四步，只需在springboot啓動類加上@EnableLog註解即可開啓LogFilter記錄請求和響應日誌的功能。

八 RestTemplate攔截器的春天

我們使用RestTemplate調用遠程接口時，有時需要在header中傳遞信息，比如：traceId，source等，便於在查詢日誌時能夠串聯一次完整的請求鏈路，快速定位問題。

這種業務場景就能通過ClientHttpRequestInterceptor接口實現，具體做法如下：

第一步，實現ClientHttpRequestInterceptor接口：

public  class RestTemplateInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        request.getHeaders().set("traceId", MdcUtil.get());
        return execution.execute(request, body);
    }
}

第二步，定義配置類：

@Configuration
public  class RestTemplateConfiguration {

    @Bean
    public RestTemplate restTemplate() {
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));
        return restTemplate;
    }

    @Bean
    public RestTemplateInterceptor restTemplateInterceptor() {
        return  new RestTemplateInterceptor();
    }
}

其中MdcUtil其實是利用MDC工具在ThreadLocal中存儲和獲取traceId

public  class MdcUtil {

    private  static  final String TRACE_ID = "TRACE_ID";

    public static String get() {
        return MDC.get(TRACE_ID);
    }

    public static void add(String value) {
        MDC.put(TRACE_ID, value);
    }
}

當然，這個例子中沒有演示MdcUtil類的add方法具體調的地方，我們可以在filter中執行接口方法之前，生成traceId，調用MdcUtil類的add方法添加到MDC中，然後在同一個請求的其他地方就能通過MdcUtil類的get方法獲取到該traceId。

九統一異常處理

以前我們在開發接口時，如果出現異常，爲了給用戶一個更友好的提示，例如：

@RequestMapping("/test")
@RestController
public  class TestController {

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

如果不做任何處理請求add接口結果直接報錯：

what？用戶能直接看到錯誤信息？

這種交互方式給用戶的體驗非常差，爲了解決這個問題，我們通常會在接口中捕獲異常：

    @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 n null;
    }
}

只需在handleException方法中處理異常情況，業務接口中可以放心使用，不再需要捕獲異常（有人統一處理了）。真是爽歪歪。

十異步也可以這麼優雅

以前我們在使用異步功能時，通常情況下有三種方式：

繼承Thread類
實現Runable接口
使用線程池

讓我們一起回顧一下：

繼承Thread類

public  class MyThread extends Thread {

    @Override
    public void run() {
        System.out.println("===call MyThread===");
    }

    public static void main(String[] args) {
        new MyThread().start();
    }
}

實現Runable接口

public  class MyWork implements Runnable {
    @Override
    public void run() {
        System.out.println("===call MyWork===");
    }

    public static void main(String[] args) {
        new Thread(new MyWork()).start();
    }
}

使用線程池

public  class MyThreadPool {

    private  static ExecutorService executorService = new ThreadPoolExecutor(1, 5, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(200));

    static  class Work implements Runnable {

        @Override
        public void run() {
            System.out.println("===call work===");
        }
    }

    public static void main(String[] args) {
        try {
            executorService.submit(new MyThreadPool.Work());
        } finally {
            executorService.shutdown();
        }

    }
}

這三種實現異步的方法不能說不好，但是spring已經幫我們抽取了一些公共的地方，我們無需再繼承Thread類或實現Runable接口，它都搞定了。

如何spring異步功能呢？

第一步，springboot項目啓動類上加@EnableAsync註解。

@EnableAsync
@SpringBootApplication
public  class Application {

    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(WebApplicationType.SERVLET).run(args);
    }
}

第二步，在需要使用異步的方法上加上@Async註解：

@Service
public  class PersonService {

    @Async
    public String get() {
        System.out.println("===add==");
        return  "data";
    }
}

然後在使用的地方調用一下：personService.get();就擁有了異步功能，是不是很神奇。

默認情況下，spring會爲我們的異步方法創建一個線程去執行，如果該方法被調用次數非常多的話，需要創建大量的線程，會導致資源浪費。

這時，我們可以定義一個線程池，異步方法將會被自動提交到線程池中執行。

@Configuration
public  class ThreadPoolConfig {

    @Value("${thread.pool.corePoolSize:5}")
    private  int corePoolSize;

    @Value("${thread.pool.maxPoolSize:10}")
    private  int maxPoolSize;

    @Value("${thread.pool.queueCapacity:200}")
    private  int queueCapacity;

    @Value("${thread.pool.keepAliveSeconds:30}")
    private  int keepAliveSeconds;

    @Value("${thread.pool.threadNamePrefix:ASYNC_}")
    private String threadNamePrefix;

    @Bean
    public Executor MessageExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(corePoolSize);
        executor.setMaxPoolSize(maxPoolSize);
        executor.setQueueCapacity(queueCapacity);
        executor.setKeepAliveSeconds(keepAliveSeconds);
        executor.setThreadNamePrefix(threadNamePrefix);
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.initialize();
        return executor;
    }
}

spring異步的核心方法：

根據返回值不同，處理情況也不太一樣，具體分爲如下情況：

十一聽說緩存好用，沒想到這麼好用

spring cache架構圖：

它目前支持多種緩存：

我們在這裏以caffeine爲例，它是spring官方推薦的。

第一步，引入caffeine的相關jar包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
    <groupId>com.github.ben-manes.caffeine</groupId>
    <artifactId>caffeine</artifactId>
    <version>2.6.0</version>
</dependency>

第二步，配置CacheManager，開啓EnableCaching


@Configuration
@EnableCaching
public  class CacheConfig {
    @Bean
    public CacheManager cacheManager(){
        CaffeineCacheManager cacheManager = new CaffeineCacheManager();
        //Caffeine配置
        Caffeine<Object, Object> caffeine = Caffeine.newBuilder()
                //最後一次寫入後經過固定時間過期
                .expireAfterWrite(10, TimeUnit.SECONDS)
                //緩存的最大條數
                .maximumSize(1000);
        cacheManager.setCaffeine(caffeine);
        return cacheManager;
    }
}

第三步，使用Cacheable註解獲取數據

@Service
public  class CategoryService {
   
   //category是緩存名稱,#type是具體的key，可支持el表達式
   @Cacheable(value = "category", key = "#type")
   public CategoryModel getCategory(Integer type) {
       return getCategoryByType(type);
   }

   private CategoryModel getCategoryByType(Integer type) {
       System.out.println("根據不同的type:" + type + "獲取不同的分類數據");
       CategoryModel categoryModel = new CategoryModel();
       categoryModel.setId(1L);
       categoryModel.setParentId(0L);
       categoryModel.setName("電器");
       categoryModel.setLevel(3);
       return categoryModel;
   }
}

調用categoryService.getCategory()方法時，先從caffine緩存中獲取數據，如果能夠獲取到數據則直接返回該數據，不會進入方法體。如果不能獲取到數據，則直接方法體中的代碼獲取到數據，然後放到caffine緩存中。

嘮嘮家常

spring中不錯的功能其實還有很多，比如：BeanPostProcessor,BeanFactoryPostProcessor,AOP,動態數據源，ImportSelector等等。

如果大家喜歡這類文章的話，我打算把spring這些有用的知識點拆分一下，寫成一個系列，敬請期待。

本文分享自微信公衆號 - 武培軒（wupeixuan404）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。

Spring中的這些能技巧，越早知道越好！

前言

一如何獲取spring容器對象

1.實現BeanFactoryAware接口

2.實現ApplicationContextAware接口

3.實現ApplicationListener接口

二如何初始化bean

1.使用@PostConstruct註解

2.實現InitializingBean接口

三自定義自己的Scope

四別說FactoryBean沒用

五輕鬆自定義類型轉換

六 spring mvc攔截器，用過的都說好

七 Enable開關真香

八 RestTemplate攔截器的春天

九統一異常處理

十異步也可以這麼優雅

十一聽說緩存好用，沒想到這麼好用

嘮嘮家常

Python 爬蟲：Spring Boot 反爬蟲的成功案例

京東科技數字化營銷能力的演進與最佳實踐| 京東雲技術團隊

Stop The World 是何時發生的？

String s="a"+"b"+"c"，到底創建了幾個對象？

呦呦，這些代碼有點臭，重構大法帶你秀(SPI接口化)，skr~

@Autowired的這些騷操作，你都知道嗎？

一鍵生成數據庫文檔，堪稱數據庫界的Swagger

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

Spring中的這些能技巧，越早知道越好！

前言

一 如何獲取spring容器對象

1.實現BeanFactoryAware接口

2.實現ApplicationContextAware接口

3.實現ApplicationListener接口

二 如何初始化bean

1.使用@PostConstruct註解

2.實現InitializingBean接口

三 自定義自己的Scope

四 別說FactoryBean沒用

五 輕鬆自定義類型轉換

六 spring mvc攔截器，用過的都說好

七 Enable開關真香

八 RestTemplate攔截器的春天

九 統一異常處理

十 異步也可以這麼優雅

十一 聽說緩存好用，沒想到這麼好用

嘮嘮家常

一如何獲取spring容器對象

二如何初始化bean

三自定義自己的Scope

四別說FactoryBean沒用

五輕鬆自定義類型轉換

九統一異常處理

十異步也可以這麼優雅

十一聽說緩存好用，沒想到這麼好用