自定義注解動(dòng)態(tài)注入 Redisson Bucket 到 Spring 容器

前置知識(shí)儲(chǔ)備

Maven 依賴

pom.xml 添加如下依賴:

        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson</artifactId>
            <version>3.16.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.12.0</version>
        </dependency>

(一)Redissson 簡單使用

1)初始化 RedissonClient

    public static RedissonClient redissonClient() {
        // 1. Create config object
        Config config = new Config();
        config.useSingleServer().setAddress("redis://host:6379");

        // 2. Create Redisson instance
        // Sync and Async API
        RedissonClient redisson = Redisson.create(config);
        return redisson;
    }

2)測(cè)試代碼

@Slf4j
public class RedisssonTest {
    public static void main(String[] args) {
        RedissonClient redissonClient = redissonClient();
        RBucket<String> bucket = redissonClient.getBucket("key");
        bucket.delete();
        log.info("value: {}", bucket.get());

        bucket.set("value");
        log.info("value: {}", bucket.get()); 
    }
}

3)控制臺(tái)輸出:

16:26:36.081 [main] INFO com.example.springdemo.RedisssonTest - value: null
16:26:36.161 [main] INFO com.example.springdemo.RedisssonTest - value: value

(二)動(dòng)態(tài)注入 RedisBean 實(shí)現(xiàn)

1)定義 redissonClient,并進(jìn)行相關(guān)配置

@Configuration
public class RedisConfig {
    @Bean
    public static RedissonClient redissonClient() {
        // 1. Create config object
        Config config = new Config();
        config.useSingleServer().setAddress("redis://host:6379");

        // 2. Create Redisson instance
        // Sync and Async API
        RedissonClient redisson = Redisson.create(config);
        return redisson;
    }
}

2)定義 RedissonBean 注解琐谤。

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface RedissonBean {
    String key();
}

@Target({ElementType.FIELD}) 表示此注解只能作用在字段上。

3)通過自定義 BeanDefinitionRegistryPostProcessor 動(dòng)態(tài)注冊(cè) RedisBean搂蜓。

@Slf4j
@Component
public class RedisssonBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {

    @SneakyThrows
    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        for (String beanName : registry.getBeanDefinitionNames()) {
            BeanDefinition beanDefinition = registry.getBeanDefinition(beanName);
            if (beanDefinition.getBeanClassName() == null) {
                continue;
            }

            if (beanDefinition.getBeanClassName().startsWith("com.example.springdemo")) {
                Class<?> beanClass = Class.forName(beanDefinition.getBeanClassName());
                FieldUtils.getFieldsListWithAnnotation(beanClass, RedissonBean.class)
                    .forEach(field -> createBeanDefinition(registry, field));
            }
        }
    }

    private void createBeanDefinition(BeanDefinitionRegistry registry, Field field) {
        // 1. 實(shí)例化一個(gè) RootBeanDefinition
        RootBeanDefinition beanDefinition = new RootBeanDefinition();

        // 2. 設(shè)置 FactoryBeanName 和 FactoryMethodName
        beanDefinition.setFactoryBeanName("redissonClient");
        String factoryMethodName = getFactoryMethodName(field);
        log.info("factoryMethodName: {}", factoryMethodName);
        beanDefinition.setFactoryMethodName(factoryMethodName);

        // 3. 設(shè)置 FactoryMethodName 的參數(shù)
        ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
        String redisKey = getRedisKey(field);
        log.info("redisKey: {}", redisKey);
        constructorArgumentValues.addGenericArgumentValue(redisKey);
        beanDefinition.setConstructorArgumentValues(constructorArgumentValues);

        // 4. 注冊(cè)到 Spring 容器中
        registry.registerBeanDefinition(redisKey, beanDefinition);
    }

    private String getFactoryMethodName(Field field) {
        String typeName = field.getType().getSimpleName();
        return "get" + typeName.substring(1);
    }

    private String getRedisKey(Field field) {
        RedissonBean annotation = field.getAnnotation(RedissonBean.class);
        return annotation.key();
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // do nothing
    }
}

4)自定義 RedissonContextAnnotationAutowireCandidateResolver,用來和第 3 步動(dòng)態(tài)注冊(cè)的 RedissBean 進(jìn)行匹配。

@Slf4j
public class RedissonContextAnnotationAutowireCandidateResolver extends ContextAnnotationAutowireCandidateResolver {
    @Override
    public boolean isAutowireCandidate(BeanDefinitionHolder bdHolder, DependencyDescriptor descriptor) {
        boolean match = super.isAutowireCandidate(bdHolder, descriptor);

        if (descriptor.getDependencyType().getName().startsWith("org.redisson.api")) {
            MethodParameter methodParameter = descriptor.getMethodParameter();
            // 1. 通過方法參數(shù)名稱找到對(duì)應(yīng)的字段
            Field field = FieldUtils.getField(methodParameter.getDeclaringClass(), methodParameter.getParameterName(), true);
            // 2. 獲取字段上的 RedissonBean 注解
            RedissonBean annotation = field.getAnnotation(RedissonBean.class);

            // 3. 如果存在注解,且注解的的 key 和 beanName 匹配蘸吓,則返回 true
            if (annotation != null && annotation.key().equals(bdHolder.getBeanName())) {
                match = true;
            }

            // 4. 打印一些調(diào)試信息
            log.info("");
            log.info("[isAutowireCandidate] [descriptor] dependencyName:{}, dependencyType:{}", descriptor.getDependencyName(), descriptor.getDependencyType());
            log.info("[isAutowireCandidate] [bdHolder] beanName:{}", bdHolder.getBeanName());
            log.info("[isAutowireCandidate] [RedissonBean] key:{}", annotation.key());
            log.info("[isAutowireCandidate]match:{}", match);
            log.info("");
        }

        return match;
    }

    @Override
    public boolean isRequired(DependencyDescriptor descriptor) {
        return super.isRequired(descriptor);
    }
}

5)自定義 ApplicationContextInitializer 替換 Spring 默認(rèn)的 ContextAnnotationAutowireCandidateResolver

package com.example.springdemo.registry;

@Slf4j
public class MyApplicationContextInitializer implements ApplicationContextInitializer {
     @Override
     public void initialize(ConfigurableApplicationContext applicationContext) {
         log.info("-----MyApplicationContextInitializer initialize-----");
         if (applicationContext.getBeanFactory() instanceof DefaultListableBeanFactory) {
             DefaultListableBeanFactory bf = (DefaultListableBeanFactory) applicationContext.getBeanFactory();
             bf.setAutowireCandidateResolver(new RedissonContextAnnotationAutowireCandidateResolver());
         } else {
             throw new IllegalStateException("錯(cuò)誤的 BeanFactory");
         }
     }
 }

并在 META-INF/spring.factories 中配置:

org.springframework.context.ApplicationContextInitializer=com.example.springdemo.registry.MyApplicationContextInitializer

6)在 DemoService 中使用 @RedissonBean 注解進(jìn)行測(cè)試撩幽。

@Slf4j
@Service
@RequiredArgsConstructor
public class DemoService {
    @RedissonBean(key = "redis1")
    private final RList<Long> list1;

    @RedissonBean(key = "redis2")
    private final RList<Long> list2;

    public void handle() {
        handleList1();
        handleList2();
    }

    public void clean() {
        list1.clear();
        list2.clear();
    }

    private void handleList1() {
        log.info("list1:{} ", list1.readAll());
        list1.add(1L);
        list1.add(2L);
        list1.add(3L);
        log.info("list1:{} ", list1.readAll());
    }

    private void handleList2() {
        log.info("list2:{} ", list2.readAll());
        list2.add(4L);
        list2.add(5L);
        list2.add(6L);
        log.info("list2:{} ", list2.readAll());
    }
}

7)測(cè)試代碼:

@Slf4j
@SpringBootApplication
public class SpringDemoApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringDemoApplication.class, args);
        DemoService demoService = context.getBean(DemoService.class);
        demoService.clean();
        demoService.handle();
    }
}

控制臺(tái)輸出:

2021-07-09 15:38:27.461  INFO 23108 --- [           main] c.e.springdemo.service.DemoService       : list1:[] 
2021-07-09 15:38:27.510  INFO 23108 --- [           main] c.e.springdemo.service.DemoService       : list1:[1, 2, 3] 
2021-07-09 15:38:27.518  INFO 23108 --- [           main] c.e.springdemo.service.DemoService       : list2:[] 
2021-07-09 15:38:27.653  INFO 23108 --- [           main] c.e.springdemo.service.DemoService       : list2:[4, 5, 6] 

參考

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末库继,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子窜醉,更是在濱河造成了極大的恐慌宪萄,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件酱虎,死亡現(xiàn)場(chǎng)離奇詭異雨膨,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)读串,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門聊记,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人恢暖,你說我怎么就攤上這事排监。” “怎么了杰捂?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵舆床,是天一觀的道長。 經(jīng)常有香客問我嫁佳,道長挨队,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任蒿往,我火速辦了婚禮盛垦,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘瓤漏。我一直安慰自己腾夯,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布蔬充。 她就那樣靜靜地躺著蝶俱,像睡著了一般。 火紅的嫁衣襯著肌膚如雪饥漫。 梳的紋絲不亂的頭發(fā)上榨呆,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音趾浅,去河邊找鬼愕提。 笑死馒稍,一個(gè)胖子當(dāng)著我的面吹牛皿哨,可吹牛的內(nèi)容都是我干的浅侨。 我是一名探鬼主播,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼证膨,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼如输!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起央勒,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤不见,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后崔步,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體稳吮,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年井濒,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了灶似。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡瑞你,死狀恐怖酪惭,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情者甲,我是刑警寧澤春感,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站虏缸,受9級(jí)特大地震影響鲫懒,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜刽辙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一窥岩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧扫倡,春花似錦谦秧、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至缘挑,卻和暖如春集歇,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背语淘。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國打工诲宇, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留际歼,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓姑蓝,卻偏偏與公主長得像鹅心,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子纺荧,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容