美文网首页springboot
springboot参数化构建

springboot参数化构建

作者: 玉米他爸 | 来源:发表于2017-05-22 14:10 被阅读0次
    自定义属性与加载

    我们在使用Spring Boot的时候,通常也需要定义一些自己使用的属性,我们可以如下方式直接定义:在src/main/resources/application.properties:加入:

    #自定义属性.
    com.xwork.system.name=david
    com.xwork.system.title=demoshow
    

    然后通过@Value("${属性名}")注解来加载对应的配置属性,具体如下:
    (这种方式已经不推荐使用了,但能正常运行)

    @Component
    public class SystemProperties {
       
        @Value("${com.xwork.system.name}")
        private String name;//系统名称
       
        @Value("${com.xwork.system.title}")
        private String title;//系统标题
     
        // 省略getter和setter
    }
    

    通过单元测试来验证BlogProperties中的属性是否已经根据配置文件加载了。
    引入单元测试依赖:

    <!-- spring boot 单元测试. -->
           <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
           </dependency>
    

    进行编码进行单元测试:

    package com.xwork;
     
    import org.junit.Assert;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.SpringApplicationConfiguration;
    import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    import com.xwork.properties.SystemProperties;
    /**
     *
     * @version v.0.1
     */
    @RunWith(SpringJUnit4ClassRunner.class)
    @SpringApplicationConfiguration(App.class)
    public class AppTest{
       
        @Autowired
        private SystemProperties systemProperties;
     
        @Test
        public void testBlog() throws Exception {
            System.out.println("AppTest.testSystem()="+systemProperties);
            Assert.assertEquals("david",systemProperties.getName());
            Assert.assertEquals("demoshow", systemProperties.getTitle());
        }
    }
    
    

    运行单元测试,完美的看到我们想要的结果了,但是我们刚刚提到了SystemProperties写法已经不推荐使用了,那么怎么写会比较perfect呢?看如下优雅的编码风格:

    先引入spring boot提供的一个配置依赖:

    <!--spring boot 配置处理器 -->      
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-configuration-processor</artifactId>
               <optional>true</optional>
            </dependency>
    

    在这里我们主要使用@ConfigurationProperties注解进行编码,
    修改BlogProperties为:

    /**
     * prefix="com.system.blog" :
     *
     * 在application.properties配置的属性前缀,
     *
     * 在类中的属性就不用使用{@value}进行注入了。
     *
     * @version v.0.1
     */
    @ConfigurationProperties(prefix="com.system.blog")
    public class BlogProperties {
       
        private String name;//博客作者
       
        private String title;//博客标题
     
        // 省略getter和setter
    }
    

    在启动类中加入:
    @EnableConfigurationProperties({SystemProperties.class})

    在运行单元测试还是能够正常进行的。

    这种的好处就是只需要配置一个地方,其它地方就是正常定义类的属性即可了。

    参数间引用

    在application.properties中的各个参数之间也可以直接引用来使用,就像下面的设置:

    com.xwork.system.desc=${com.xwork.system.name}正在写《${com.xwork.system.title}》
    

    com.xwork.system.desc参数引用了上文中定义的name和title属性,最后该属性的值就是Angel正在努力写《Spring Boot教程》。

    使用随机数

    在一些情况下,有些参数我们需要希望它不是一个固定的值,比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}来产生int值、long值或者string字符串,来支持属性的随机值。

    # 随机字符串
    com.xwork.system.value=${random.value} 
    # 随机int
    com.xwork.system.number=${random.int} 
    # 随机long
    com.xwork.system.bignumber=${random.long} 
    # 10以内的随机数
    com.xwork.system.test1=${random.int(10)} 
    # 10-20的随机数
    com.xwork.system.test2=${random.int[10,20]} 
    
    通过命令行设置属性值

    相信使用过一段时间Spring Boot的用户,一定知道这条命令:java -jar xxx.jar --server.port=8888,通过使用--server.port属性来设置xxx.jar应用的端口为8888。
    在命令行运行时,连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以,java -jar xxx.jar --server.port=8888命令,等价于我们在application.properties中添加属性server.port=8888,该设置在样例工程中可见,读者可通过删除该值或使用命令行来设置该值来验证。
    通过命令行来修改属性值固然提供了不错的便利性,但是通过命令行就能更改应用运行的参数,那岂不是很不安全?是的,所以Spring Boot也贴心的提供了屏蔽命令行访问属性的设置,只需要这句设置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)。

    多环境配置

    以上都不是重点,这才是重点,这才是重点,这才是重点,重要的事情说3遍。我们在开发Spring Boot应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事。
    对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,Spring Boot也不例外,或者说更加简单。

    在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式,其中{profile}对应你的环境标识,比如:

      application-dev.properties: 开发环境
      application-test.properties: 测试环境
      application-prod.properties:生产环境
    

    至于哪个具体的配置文件会被加载,需要在application.properties文件中通过spring.profiles.active属性来设置,其值对应{profile}值。

    如:spring.profiles.active=test就会加载application-test.properties配置文件内容下面,以不同环境配置不同的服务端口为例,进行样例实验。

    针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

    在这三个文件均都设置不同的server.port属性,如:dev环境设置为8080,test环境设置为9090,prod环境设置为80

    application.properties中设置spring.profiles.active=dev,就是说默认以dev环境设置

    测试不同配置的加载:

       执行java -jar xxx.jar,可以观察到服务端口被设置为8080,也就是默认的开发环境(dev)
    
    
       执行java -jar xxx.jar --spring.profiles.active=test,可以观察到服务端口被设置为9090,也就是测试环境的配置(test)
    
    
       执行java -jar xxx.jar --spring.profiles.active=prod,可以观察到服务端口被设置为80,也就是生产环境的配置(prod)
    

    按照上面的实验,可以如下总结多环境的配置思路:

    application.properties中配置通用内容,并设置spring.profiles.active=dev,以开发环境为默认配置
    application-{profile}.properties中配置各个环境不同的内容
    通过命令行方式去激活不同环境的配置。

    多环境高级应用

    在某些情况下,应用的某些业务逻辑可能需要有不同的实现。例如邮件服务,假设EmailService中包含的send(String email)方法向指定地址发送电子邮件,但是我们仅仅希望在生产环境中才执行真正发送邮件的代码,而开发环境里则不发送以免向用户发送无意义的垃圾邮件。

    我们可以借助Spring的注解@Profile实现这样的功能,这样需要定义两个实现EmailService接口的类:

    /**
     * 发送邮件接口.
     * @version v.0.1
     */
    public interface EmailService {
        /**发送邮件*/
        publicvoid send();
    }
    

    发送邮件的具体实现(dev-开发环境的代码):

    @Service
    @Profile("dev") //开发环境的时候.
    public class DevEmailServiceImpl implements EmailService{
     
        @Override
        publicvoid send() {
           System.out.println("DevEmailServiceImpl.send().开发环境不执行邮件的发送.");
        }
    }
    

    发送邮件的具体实现(prod-生产环境的代码):

    @Service
    @Profile("prod") //生产环境.
    public class ProdEmailServiceImpl2 implements EmailService{
       
        @Override
        publicvoid send() {
           System.out.println("DevEmailServiceImpl.send().生产环境执行邮件的发送.");
           //具体的邮件发送代码.
           //mail.send();
        }
    }
    

    @Profile("dev")表明只有Spring定义的Profile为dev时才会实例化DevEmailService这个类。那么如何设置Profile呢?

    在配置文件中指定
    在application.properties中加入:
    spring.profiles.active=dev
    通过命令行参数
    java -jar app.jar --spring.profiles.active=dev

    相关文章

      网友评论

        本文标题:springboot参数化构建

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