02_spring-boot-starter.md

spring-boot-starter

在前面我们创建工程的时候，选择了依赖Web，我们打开pom.xml，将看到

    ...
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    ...
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    ...
  1. 这里的dependency里面没有version标签，这是为什么呢？因为我们继承了spring-boot-starter-parent，该包中加入了大部分我们需要的依赖包及其版本号，根据mvn的依赖继承原理，我们这里就不需要再写版本号了。
  2. 我们的第一个依赖spring-boot-starter-web，它包含了编写一个web站点需要的东西，比如我们要使用的注解：@SpringBootApplication, @RestController, @RequestMapping, @ResponseBody，等等。

我们之后会经常使用别人写好的starter，必要的时候也需要自己写。为了弄清楚其中的原委，我们接下来写一个试试。

重构项目结构

1. 添加目录learn-app，将src目录移动到learn-app下，修改顶层pom.xml。

    ...
    <packaging>pom</packaging>
    ...
        <modules>
            <module>learn-app</module>
        </modules>
    ...
  1. 修改packaging为pom。
  2. 添加modules标签，将learn-app模块引进来。

这一步不是必需的，只是为了方便我们以后的开发，也顺便演示一下项目结构的重构技巧。

2. 在learn-app下添加pom.xml 

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <artifactId>learn-app</artifactId>
    <packaging>jar</packaging>

    <name>learn-app</name>
    <description>spring-boot-learn-app</description>

    <parent>
        <groupId>me.readyou</groupId>
        <artifactId>spring-boot-learn</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

这里主要修改了parent标签。

3. 在Maven Projects窗口的learn-app下重新创建Debug Configuration（见工程初始化）

创建包string-handler-spring-boot-starter

通常写一个starter需要包含以下几个部分：

  1. 主服务类：将来会通过Autowired使用的类。

  2. 属性配置类：用来从配置文件或配置服务器获取配置。

  3. 自动配置类：根据配置的属性，生成主服务类的对象，注入到系统中。

  4. 将自动配置类添加到resources/META-INF/spring.factories文件中，没有这一步的话，上面一步不生效，即通过本配置，才能让系统找到相应的自动配置类，并进行依赖注入。

  5. 新建目录与文件

    ├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── me
│       │       └── readyou
│       │           └── springbootlearn
│       │               └── starter
│       │                   └── stringhandler
│       │                       ├── StringHandlerAutoConfiguration.java
│       │                       ├── StringHandlerProperties.java
│       │                       └── StringHandlerService.java
│       └── resources
│           └── META-INF
│               └── spring.factories

  6. 编辑pom.xml：

    <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>me.readyou</groupId>
    <artifactId>string-handler-spring-boot-starter</artifactId>
    <packaging>jar</packaging>
    <version>0.0.1-SNAPSHOT</version>

    <name>string-handler-spring-boot-starter</name>
    <description>starter to log execute time of controller</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                 <!--Import dependency management from Spring Boot-->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>1.5.2.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

  7. 编辑StringHandlerService.java：

    package me.readyou.springbootlearn.starter.stringhandler;

/**
 * Created by wuxinlong on 18/5/2.
 */
// 这是我们要提供的Service，但这里并不需要@service的注解
// 因为我们在自动配置类中，会直接调用构造函数生成对象
public class StringHandlerService {
    private int handleType;

    public StringHandlerService(int handleType) {
        this.handleType = handleType;
    }

    public String doHandle(String str) {
        if (str == null) {
            return null;
        }

        switch (handleType) {
            case 1:
                return str.toLowerCase();
            case 2:
                return str.toUpperCase();
            default:
                return str.toUpperCase();
        }
    }
}

  8. 编辑StringHandlerProperties.java：

    package me.readyou.springbootlearn.starter.stringhandler;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Created by wuxinlong on 18/5/2.
 */
@ConfigurationProperties("spring.boot.learn.string.handler")
public class StringHandlerProperties {
    private int handleType;

    public int getHandleType() {
        return handleType;
    }

    public StringHandlerProperties setHandleType(int handleType) {
        this.handleType = handleType;
        return this;
    }
}

  9. 编辑StringHandlerAutoConfiguration.java，通过Autowired使用StringHandlerProperties获取属性，并利用属性生成真正的Service对象：

    package me.readyou.springbootlearn.starter.stringhandler;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Created by wuxinlong on 18/5/2.
 */
@Configuration
@ConditionalOnClass(StringHandlerService.class)
@EnableConfigurationProperties(StringHandlerProperties.class)
public class StringHandlerAutoConfiguration {
    @Autowired
    private StringHandlerProperties stringHandlerProperties;

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnProperty(prefix = "spring.boot.learn.string.handler", value = "enabled", havingValue = "true")
    StringHandlerService exampleService() {
        return new StringHandlerService(stringHandlerProperties.getHandleType());
    }
}

    解释一下这里的几个注解：@Bean表示生成一个新的Bean；@ConditionalOnMissingBean表示没有该类时才配置，防止重复配置；@ConditionalOnProperty只有属性满足某些条件时才生效。

  10. 编辑spring.factories

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
me.readyou.springbootlearn.starter.stringhandler.StringHandlerAutoConfiguration

  11. 执行命令mvn install安装包到本地仓库。

使用starter包

  1. 添加依赖

    <!-- spring-boot-learn/pom.xml -->
...
            <dependency>
                <groupId>me.readyou</groupId>
                <artifactId>string-handler-spring-boot-starter</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
...

    <!-- spring-boot-learn/learn-app/pom.xml -->
...
        <dependency>
            <groupId>me.readyou</groupId>
            <artifactId>string-handler-spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
...

  2. 修改spring-boot-learn/learn-app/src/main/resources/application.properties，添加配置：

    spring.boot.learn.string.handler.enabled=true
spring.boot.learn.string.handler.handleType=2

  3. 在controller类中使用

// ...
public class HelloController {
    @Autowired
    private StringHandlerService stringHandlerService;

    @RequestMapping("/")
    @ResponseBody
    String home() {
        String msg = "Hello World!";
        return stringHandlerService.doHandle(msg);
    }
}

效果

  1. 重启服务，浏览器中可以看到全小写的hello world!。
  2. 修改配置项：spring.boot.learn.string.handler.handleType=2，重启服务，浏览器中可以看到全大写的HELLO WORLD!。

原文链接

https://github.com/readyou/spring-boot-learn/blob/master/docs/01_project-init.md

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,542评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,596评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,021评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,682评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,792评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,985评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,107评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,845评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,299评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,441评论 4赞 333
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,072评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2赞 350