SpringBoot編寫自己的starter

SpringBoot是約定優(yōu)于配置產(chǎn)物,其核心就是所對(duì)應(yīng)的starter,只要在配置文件中填寫所需要的參數(shù),就能夠?qū)崿F(xiàn)自動(dòng)配置。

用阿里云ONS為例,編寫一個(gè)自定義starter用于發(fā)送消息。

開(kāi)始

新建一個(gè)maven模塊,增加對(duì)應(yīng)庫(kù)


<groupId>com.zxcvbnmzsedr</groupId>
<artifactId>ons-module</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>    
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starters</artifactId>
    <version>1.3.5.RELEASE</version>
</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>com.aliyun.openservices</groupId>
        <artifactId>ons-client</artifactId>
        <version>RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.31</version>
    </dependency>
</dependencies>

幾個(gè)核心類:

  • OnsClient: 注解,方法返回值直接發(fā)送到阿里云
  • OnsClientAspect: 注解的AOP實(shí)現(xiàn)
  • OnsAutoConfiguration: 整個(gè)項(xiàng)目的配置
  • OnsProperties: 用于提取配置文件

OnsClient:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnsClient {
    /**
     * 阿里云的topicId
     */
    String topicId();

    /**
     * 指定tags
     */
    String tags();

    /**
     * producerId
     */
    String producerId();
}

OnsClientAspect

@Component
@Aspect
public class OnsClientAspect {
    private Logger logger = LoggerFactory.getLogger(OnsAutoConfiguration.class);
    @Autowired
    private Map<String,Producer> onsProducer;
    @Pointcut("@annotation(com.zxcvbnmzsedr.ons.annotation.OnsClient)")
    private void cut() { }

    @Around(value = "cut()&& @annotation(onsClient)")
    public Object aroundMethod(ProceedingJoinPoint point, OnsClient onsClient) {
        Object result = null;
        String producerId = onsClient.producerId();
        String tags = onsClient.tags();
        Producer producer = onsProducer.get(producerId);
        try {
            producer.start();
            result = point.proceed();
            Message message = new Message(onsClient.topicId(),tags, JSON.toJSONBytes(result));
            SendResult sendResult = producer.send(message);
            assert sendResult != null;
            logger.info("messageId"+sendResult.getMessageId());
        } catch (ONSClientException e){
            logger.error(e.getMessage());
        } catch (Throwable e) {
            logger.error(e.getMessage());
        } finally {
            producer.shutdown();
        }
        return result;
    }
}

OnsAutoConfiguration

@Configuration
@EnableConfigurationProperties(OnsProperties.class)
public class OnsAutoConfiguration {
    @Autowired
    private OnsProperties onsProperties;

    @Bean
    public Map<String,Producer> onsProducer(){
        Map<String,Producer> producerMap = new HashMap<String, Producer>();
        for(String producer:onsProperties.getProducerIds()){
            ProducerBean producerBean = new ProducerBean();
            Properties properties = new Properties();
            properties.put(PropertyKeyConst.ProducerId, producer);
            properties.put(PropertyKeyConst.AccessKey, onsProperties.getAccessKey());
            properties.put(PropertyKeyConst.SecretKey, onsProperties.getAccessKeySecret());
            properties.put(PropertyKeyConst.ONSAddr, onsProperties.getOnsAddr());
            producerBean.setProperties(properties);
            producerMap.put(producer,producerBean);
        }
        return producerMap;
    }

    @Bean
    public OnsClientAspect onsClientAspect(){
        return new OnsClientAspect();
    }
}

OnsProperties

@ConfigurationProperties(prefix = "ons")
public class OnsProperties {

    private String accessKey;

    private String accessKeySecret;

    private String onsAddr;

    private String[] producerIds;

    private String producerId;
    @PostConstruct
    public void init() {
        this.producerIds = producerId.split(",");
    }

    public String[] getProducerIds() {
        return producerIds;
    }

    public void setProducerIds(String[] producerIds) {
        this.producerIds = producerIds;
    }

    public String getProducerId() {
        return producerId;
    }

    public void setProducerId(String producerId) {
        this.producerId = producerId;
    }

    public String getAccessKey() {
        return accessKey;
    }

    public void setAccessKey(String accessKey) {
        this.accessKey = accessKey;
    }

    public String getAccessKeySecret() {
        return accessKeySecret;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }

    public String getOnsAddr() {
        return onsAddr;
    }

    public void setOnsAddr(String onsAddr) {
        this.onsAddr = onsAddr;
    }
}

src/main/resources目錄下新建META-INF文件夾,然后新建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.zxcvbnmzsedr.ons.autoconfigure.OnsAutoConfiguration

把這幾項(xiàng)配置起來(lái)就能使用了

使用方法

在pom文件引用ons模塊

<dependency>
    <groupId>com.zxcvbnmzsedr</groupId>
    <artifactId>ons-module</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

配置文件application.yml

ons:
  accessKey: XXX
  accessKeySecret: XXX
  onsAddr: XXX
  # 如果有多個(gè)生產(chǎn)者,使用逗號(hào)隔開(kāi)
  producerId: XXX,XXX,XXX

在使用時(shí)候會(huì)把返回值直接序列化成json直接發(fā)送到ONS上,
需要指定topicId,producerId,tags

@OnsClient(topicId = "XXX",producerId = "XXX",tags = "XXX")
    public String test(){

        return "ddd";
    }

代碼在github上,https://github.com/zxcvbnmzsedr/ons-module

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容