Spring中11個最常用的擴展點總結(jié),你知道幾個

更新時間：2022年12月20日 07:54:25 作者：JAVA旭陽

我們知道IOC（控制反轉(zhuǎn)）和AOP（面向切面編程）是spring的基石,除此之外spring的擴展能力非常強,下面這篇文章主要給大家介紹了關(guān)于Spring中11個最常用的擴展點的相關(guān)資料,需要的朋友可以參考下

前言

在使用spring的過程中，我們有沒有發(fā)現(xiàn)它的擴展能力很強呢？由于這個優(yōu)勢的存在，使得spring具有很強的包容性，所以很多第三方應(yīng)用或者框架可以很容易的投入到spring的懷抱中。今天我們主要來學(xué)習(xí)Spring中很常用的11個擴展點，你用過幾個呢？

1. 類型轉(zhuǎn)換器

如果接口中接收參數(shù)的實體對象中，有一個字段類型為Date，但實際傳遞的參數(shù)是字符串類型：2022-12-15 10:20:15，該如何處理？

Spring提供了一個擴展點，類型轉(zhuǎn)換器Type Converter，具體分為3類：

Converter<S,T>: 將類型 S 的對象轉(zhuǎn)換為類型 T 的對象
ConverterFactory<S, R>: 將 S 類型對象轉(zhuǎn)換為 R 類型或其子類對象
GenericConverter：它支持多種源和目標(biāo)類型的轉(zhuǎn)換，還提供了源和目標(biāo)類型的上下文。此上下文允許您根據(jù)注釋或?qū)傩孕畔?zhí)行類型轉(zhuǎn)換。

還是不明白的話，我們舉個例子吧。

定義一個用戶對象

@Data
public class User {
    private Long id;
    private String name;
    private Date registerDate;
}

實現(xiàn)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;
    }
}

將新定義的類型轉(zhuǎn)換器注入到Spring容器中

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new DateConverter());
    }
}

調(diào)用接口測試

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

請求接口時，前端傳入的日期字符串，會自動轉(zhuǎn)換成Date類型。

2. 獲取容器Bean

在我們?nèi)粘ｉ_發(fā)中，經(jīng)常需要從Spring容器中獲取bean，但是你知道如何獲取Spring容器對象嗎？

2.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");
    }
}

實現(xiàn)BeanFactoryAware接口，然后重寫setBeanFactory方法，可以從方法中獲取spring容器對象。

2.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");
    }
}

實現(xiàn)ApplicationContextAware接口，然后重寫setApplicationContext方法，也可以通過該方法獲取spring容器對象。

2.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");
    }
}

3. 全局異常處理

以往我們在開發(fā)界面的時候，如果出現(xiàn)異常，要給用戶更友好的提示，例如：

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

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

如果不對請求添加接口結(jié)果做任何處理，會直接報錯：

用戶可以直接看到錯誤信息嗎？

這種交互給用戶帶來的體驗非常差。為了解決這個問題，我們通常在接口中捕獲異常：

@GetMapping("/add")
public String add() {
    String result = "success";
    try {
        int a = 10 / 0;
    } catch (Exception e) {
        result = "error";
    }
    return result;
}

界面修改后，出現(xiàn)異常時會提示：“數(shù)據(jù)異常”，更加人性化。

看起來不錯，但是有一個問題。

如果只是一個接口還好，但是如果項目中有成百上千個接口，還得加異常捕獲代碼嗎？

答案是否定的，這就是全局異常處理派上用場的地方：RestControllerAdvice。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public String handleException(Exception e) {
        if (e instanceof ArithmeticException) {
            return "data error";
        }
        if (e instanceof Exception) {
            return "service error";
        }
        retur null;
    }
}

方法中處理異常只需要handleException，在業(yè)務(wù)接口中就可以安心使用，不再需要捕獲異常（統(tǒng)一有人處理）。

4. 自定義攔截器

Spring MVC攔截器，它可以獲得HttpServletRequest和HttpServletResponse等web對象實例。

Spring MVC攔截器的頂層接口是HandlerInterceptor，它包含三個方法：

preHandle 在目標(biāo)方法執(zhí)行之前執(zhí)行
執(zhí)行目標(biāo)方法后執(zhí)行的postHandle
afterCompletion 在請求完成時執(zhí)行

為了方便，我們一般繼承HandlerInterceptorAdapter，它實現(xiàn)了HandlerInterceptor。

如果有授權(quán)鑒權(quán)、日志、統(tǒng)計等場景，可以使用該攔截器，我們來演示下吧。

寫一個類繼承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) {
        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在請求接口時可以自動攔截接口，并通過攔截器驗證權(quán)限。

5. 導(dǎo)入配置

有時我們需要在某個配置類中引入其他的類，引入的類也加入到Spring容器中。這時候可以使用注解@Import來完成這個功能。

如果你查看它的源代碼，你會發(fā)現(xiàn)導(dǎo)入的類支持三種不同的類型。

但是我覺得最好把普通類的配置類和@Configuration注解分開解釋，所以列出了四種不同的類型：

5.1 通用類

這種引入方式是最簡單的，引入的類會被實例化為一個bean對象。

public class A {
}

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

通過@Import注解引入類A，spring可以自動實例化A對象，然后在需要使用的地方通過注解@Autowired注入：

@Autowired
private A a;

5.2 配置類

這種引入方式是最復(fù)雜的，因為@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 {
}

@Configuration注解的配置類通過@Import注解導(dǎo)入，配置類@Import、@ImportResource相關(guān)注解引入的類會一次性全部遞歸引入@PropertySource所在的屬性。

5.3 ImportSelector

該導(dǎo)入方法需要實現(xiàn)ImportSelector接口

public class AImportSelector implements ImportSelector {

    private static final String CLASS_NAME = "com.sue.cache.service.test13.A";

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

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

這種方法的好處是selectImports方法返回的是一個數(shù)組，也就是說可以同時引入多個類，非常方便。

5.4 ImportBeanDefinitionRegistrar

該導(dǎo)入方法需要實現(xiàn)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方法中獲取，可以手動創(chuàng)建BeanDefinition注冊到BeanDefinitionRegistry種。

6. 當(dāng)工程啟動時

有時候我們需要在項目啟動的時候自定義一些額外的功能，比如加載一些系統(tǒng)參數(shù)，完成初始化，預(yù)熱本地緩存等。我們應(yīng)該做什么？

好消息是 SpringBoot 提供了：

CommandLineRunner
ApplicationRunner

這兩個接口幫助我們實現(xiàn)了上面的需求。

它們的用法很簡單，以ApplicationRunner接口為例：

@Component
public class TestRunner implements ApplicationRunner {

    @Autowired
    private LoadDataService loadDataService;

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

實現(xiàn)ApplicationRunner接口，重寫run方法，在該方法中實現(xiàn)您的自定義需求。

如果項目中有多個類實現(xiàn)了ApplicationRunner接口，如何指定它們的執(zhí)行順序？

答案是使用@Order(n)注解，n的值越小越早執(zhí)行。當(dāng)然，順序也可以通過@Priority注解來指定。

7. 修改BeanDefinition

在實例化Bean對象之前，Spring IOC需要讀取Bean的相關(guān)屬性，保存在BeanDefinition對象中，然后通過BeanDefinition對象實例化Bean對象。

如果要修改BeanDefinition對象中的屬性怎么辦？

答案：我們可以實現(xiàn) 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", "Tom");
        defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
    }
}

在postProcessBeanFactory方法中，可以獲取BeanDefinition的相關(guān)對象，修改對象的屬性。

8. 初始化 Bean 前和后

有時，您想在 bean 初始化前后實現(xiàn)一些您自己的邏輯。

這時候就可以實現(xiàn)：BeanPostProcessor接口。

該接口目前有兩個方法：

postProcessBeforeInitialization：應(yīng)該在初始化方法之前調(diào)用。
postProcessAfterInitialization：此方法在初始化方法之后調(diào)用。

@Component
    public class MyBeanPostProcessor implements BeanPostProcessor {

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

我們經(jīng)常使用的@Autowired、@Value、@Resource、@PostConstruct等注解都是通過AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor來實現(xiàn)的。

9. 初始化方法

目前在Spring中初始化bean的方式有很多種：

使用@PostConstruct注解
實現(xiàn)InitializingBean接口

9.1 使用 `@PostConstruct`

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

為需要初始化的方法添加注解@PostConstruct，使其在Bean初始化時執(zhí)行。

9.2 實現(xiàn)初始化接口`InitializingBean`

@Service
public class BService implements InitializingBean {

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

實現(xiàn)InitializingBean接口，重寫afterPropertiesSet方法，在該方法中可以完成初始化功能。

10. 關(guān)閉Spring容器前

有時候，我們需要在關(guān)閉spring容器之前做一些額外的工作，比如關(guān)閉資源文件。

此時你可以實現(xiàn) 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容器銷毀之前，會調(diào)用destroy方法做一些額外的工作。

通常我們會同時實現(xiàn)InitializingBean和DisposableBean接口，重寫初始化方法和銷毀方法。

11. 自定義Bean的scope

我們都知道spring core默認只支持兩種Scope：

Singleton單例，從spring容器中獲取的每一個bean都是同一個對象。
prototype多實例，每次從spring容器中獲取的bean都是不同的對象。

Spring Web 再次擴展了 Scope，添加

RequestScope：同一個請求中從spring容器中獲取的bean都是同一個對象。
SessionScope：同一個session從spring容器中獲取的bean都是同一個對象。

盡管如此，有些場景還是不符合我們的要求。

比如我們在同一個線程中要從spring容器中獲取的bean都是同一個對象，怎么辦？

答案：這需要一個自定義范圍。

實現(xiàn) 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() {
    }
}

總結(jié)

本文總結(jié)了Spring中很常用的11個擴展點，可以在Bean創(chuàng)建、初始化到銷毀各個階段注入自己想要的邏輯，也有Spring MVC相關(guān)的攔截器等擴展點，希望對大家有幫助。

到此這篇關(guān)于Spring中11個最常用的擴展點的文章就介紹到這了,更多相關(guān)Spring常用擴展點內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

国产无遮挡裸体免费直播视频,久久精品国产蜜臀av,动漫在线视频一区二区,欧亚日韩一区二区三区,久艹在线免费视频,国产精品美女网站免费,正在播放 97超级视频在线观看,斗破苍穹年番在线观看免费,51最新乱码中文字幕

Spring中11個最常用的擴展點總結(jié),你知道幾個

目錄

前言

1. 類型轉(zhuǎn)換器

2. 獲取容器Bean

2.1 BeanFactoryAware

2.2 ApplicationContextAware

2.3 ApplicationListener

3. 全局異常處理

4. 自定義攔截器

5. 導(dǎo)入配置

5.1 通用類

5.2 配置類

5.3 ImportSelector

5.4 ImportBeanDefinitionRegistrar

6. 當(dāng)工程啟動時

7. 修改BeanDefinition

8. 初始化 Bean 前和后

9. 初始化方法

9.1 使用 `@PostConstruct`

9.2 實現(xiàn)初始化接口`InitializingBean`

10. 關(guān)閉Spring容器前

11. 自定義Bean的scope

總結(jié)

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

国产无遮挡裸体免费直播视频,久久精品国产蜜臀av,动漫在线视频一区二区,欧亚日韩一区二区三区,久艹在线 免费视频,国产精品美女网站免费,正在播放 97超级视频在线观看,斗破苍穹年番在线观看免费,51最新乱码中文字幕

Spring中11個最常用的擴展點總結(jié),你知道幾個

目錄

前言

1. 類型轉(zhuǎn)換器

2. 獲取容器Bean

2.1 BeanFactoryAware

2.2 ApplicationContextAware

2.3 ApplicationListener

3. 全局異常處理

4. 自定義攔截器

5. 導(dǎo)入配置

5.1 通用類

5.2 配置類

5.3 ImportSelector

5.4 ImportBeanDefinitionRegistrar

6. 當(dāng)工程啟動時

7. 修改BeanDefinition

8. 初始化 Bean 前和后

9. 初始化方法

9.1 使用 @PostConstruct

9.2 實現(xiàn)初始化接口InitializingBean

10. 關(guān)閉Spring容器前

11. 自定義Bean的scope

總結(jié)

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

国产无遮挡裸体免费直播视频,久久精品国产蜜臀av,动漫在线视频一区二区,欧亚日韩一区二区三区,久艹在线免费视频,国产精品美女网站免费,正在播放 97超级视频在线观看,斗破苍穹年番在线观看免费,51最新乱码中文字幕

9.1 使用 `@PostConstruct`

9.2 實現(xiàn)初始化接口`InitializingBean`