spring中這些程式設計技巧，真的讓我愛不釋手

阿新 • • 發佈：2021-01-11

前言

最近越來越多的讀者認可我的文章，還是挺讓人高興的。有些讀者希望我多分享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等

這類介面是很常用的功能。具體功能如下：

二如何初始化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只有兩種：

SCOPE_SINGLETON 單例，每次從spring容器中獲取到的bean都是同一個物件。
SCOPE_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介面。

足以說明該介面的重要性，請勿忽略它好嗎？

我們一起定義自己的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請求物件例項。

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

第一步，實現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方法中看到呼叫過程：

六 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 "伺服器內部異常";
        }
        return 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這些有用的知識點拆分一下，寫成一個系列，希望您會喜歡這種稱述方式。

最後說一句(求關注，別白嫖我)

如果這篇文章對您有所幫助，或者有所啟發的話，幫忙掃描下發二維碼關注一下，您的支援是我堅持寫作最大的動力。

求一鍵三連：點贊、轉發、在看。

關注公眾號：【蘇三說技術】，在公眾號中回覆：面試、程式碼神器、開發手冊、時間管理有超讚的粉絲福利，另外回覆：加群，可以跟很多BAT大廠的前輩交流和學習。

spring中這些程式設計技巧，真的讓我愛不釋手

前言

一如何獲取spring容器物件

1.實現BeanFactoryAware介面

2.實現ApplicationContextAware介面

3.實現ApplicationListener介面

二如何初始化bean

1.使用@PostConstruct註解

2.實現InitializingBean介面

三自定義自己的Scope

四別說FactoryBean沒用

五輕鬆自定義型別轉換

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

六 Enable開關真香

七 RestTemplate攔截器的春天

八統一異常處理

九非同步也可以這麼優雅

十聽說快取好用，沒想到這麼好用

嘮嘮家常

最後說一句(求關注，別白嫖我)

spring中這些程式設計技巧，真的讓我愛不釋手

總是說spring難學？來看完這些spring的註解及其解釋，真香！

這6個電腦操作技巧，會讓你愛上Win10系統

這些vue技巧，你值得擁有

計算機網路中這些高頻考題，你還在死記硬背嗎？（三）

【Python進階】掌握這些騷技巧，99%的檔案操作都遊刃有餘！

還不懂spring中的bean的話，你一定得好好看看這篇文章

（乾貨）Python高效程式設計技巧，幫你提高工作效率！

Java 中的語法糖，真甜。

Spring中的JDK黑客，Spring黑客

字串拼接還在用StringBuilder？快試試Java8中的StringJoiner吧，真香！

Android Studio 掌握這些除錯技巧，Debug 能力不能再高啦

【C語言學習筆記】超級炫酷的C語言實用小技巧！學會這些隱藏技巧，早下班一小時！

關於win11中liunx子系統中部署docker 容器，如何讓區域網內其它主機訪問

NB了！這份蘊含1000多道BTAJ精選JAVA面試題的“至尊級”面試寶典，竟讓我拿到數家大廠offer

跪了！阿里內部瘋傳的神仙“MySQL面試寶典”，居然讓我拿到30Koffer！建議收藏。

寫了一套優雅介面之後，領導讓我給大家講講這背後的技術原理

入職第一週，組長讓我把部門redis服務搞成哨兵模式...慌

年底了，領導讓我統計這樣的銷量，怎麼辦？

常用的echo和cat，這次讓我折在了特殊字元丟失問題上

spring中這些程式設計技巧，真的讓我愛不釋手

前言

一 如何獲取spring容器物件

1.實現BeanFactoryAware介面

2.實現ApplicationContextAware介面

3.實現ApplicationListener介面

二 如何初始化bean

1.使用@PostConstruct註解

2.實現InitializingBean介面

三 自定義自己的Scope

四 別說FactoryBean沒用

五 輕鬆自定義型別轉換

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

六 Enable開關真香

七 RestTemplate攔截器的春天

八 統一異常處理

九 非同步也可以這麼優雅

十 聽說快取好用，沒想到這麼好用

嘮嘮家常

最後說一句(求關注，別白嫖我)

相關推薦

一如何獲取spring容器物件

二如何初始化bean

三自定義自己的Scope

四別說FactoryBean沒用

五輕鬆自定義型別轉換

八統一異常處理

九非同步也可以這麼優雅

十聽說快取好用，沒想到這麼好用