美文网首页
自定义注解动态注入 Redisson Bucket 到 Spri

自定义注解动态注入 Redisson Bucket 到 Spri

作者: 蓝笔头 | 来源:发表于2021-07-10 11:09 被阅读0次

前置知识储备

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)测试代码

@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)控制台输出:

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

(二)动态注入 RedisBean 实现

1)定义 redissonClient,并进行相关配置

@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 动态注册 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. 实例化一个 RootBeanDefinition
        RootBeanDefinition beanDefinition = new RootBeanDefinition();

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

        // 3. 设置 FactoryMethodName 的参数
        ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
        String redisKey = getRedisKey(field);
        log.info("redisKey: {}", redisKey);
        constructorArgumentValues.addGenericArgumentValue(redisKey);
        beanDefinition.setConstructorArgumentValues(constructorArgumentValues);

        // 4. 注册到 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 步动态注册的 RedissBean 进行匹配。

@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. 通过方法参数名称找到对应的字段
            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. 打印一些调试信息
            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 默认的 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("错误的 BeanFactory");
         }
     }
 }

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

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

6)在 DemoService 中使用 @RedissonBean 注解进行测试。

@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)测试代码:

@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();
    }
}

控制台输出:

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] 

参考

相关文章

  • 自定义注解动态注入 Redisson Bucket 到 Spri

    前置知识储备 (一)自定义 BeanDefinition[https://www.jianshu.com/p/65...

  • spring的ioc和aop的原理

    IOC:依赖注入(控制反转),两种注入方式:依赖注入和设置注入,通过容器动态地将某种依赖注入到组件中,通过Spri...

  • springboot自定义filter

    1.定义自定义filter并实现 javax.servlet.Filter接口; 2.将filter注入到spri...

  • 动态代理实现控件点击事件注入

    概述 本文主要分享基于动态代理实现控件点击事件注入。 实现思路: 自定义EventType注解标记需要点击事件类型...

  • 反射与注解实现页面跳转参数注入

    概述 本文主要分享基于反射与注解实现页面跳转参数注入。 实现思路: 自定义AutoWired注解标记需要注入的成员...

  • 反射与注解实现控件注入

    概述 本文主要分享基于注解和反射实现控件注入。 实现思路: 自定义BindView注解标记需要注入的控件 查找页面...

  • Spring的IOC实现

    Inversion of control的原理实现: 自定义注解: 提供Bean的工厂,用于给代理获取然后注入到指...

  • Spring Properties Loader

    最近在做Spring项目时,使用到了@Value注解,可以动态注入到注解了@Value的属性上;一般我们会把用到的...

  • Java 代理

    静态代理 动态代理 动态代理, 日志切片使用反射获得方法 动态代理, 自定义注解(对注解的方法,使用动态代理添加切...

  • 自定义依赖注入注解实现@Autowired功能

    通过自定义注解来实现注入功能有两种方法第一种通过元注解的方式,在自定义注解上面用@Autowired标注既可以实现...

网友评论

      本文标题:自定义注解动态注入 Redisson Bucket 到 Spri

      本文链接:https://www.haomeiwen.com/subject/tsltpltx.html