SpringBoot编写自己的starter

SpringBoot是约定优于配置产物,其核心就是所对应的starter,只要在配置文件中填写所需要的参数,就能够实现自动配置。

用阿里云ONS为例,编写一个自定义starter用于发送消息。

开始

新建一个maven模块,增加对应库


<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>

几个核心类:

  • OnsClient: 注解,方法返回值直接发送到阿里云
  • OnsClientAspect: 注解的AOP实现
  • OnsAutoConfiguration: 整个项目的配置
  • 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

把这几项配置起来就能使用了

使用方法

在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
  # 如果有多个生产者,使用逗号隔开
  producerId: XXX,XXX,XXX

在使用时候会把返回值直接序列化成json直接发送到ONS上,
需要指定topicId,producerId,tags

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

        return "ddd";
    }

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容