Spring Boot学习[三] 配置文件

我们先了解下入口类和@SpringBootApplication注解

上文说过@SpringBootApplication注解,我们新建一个Project系统都会帮我们创建一个名为artifactId+Application的入口类,这个类中有一个main方法,这个main方法就是一个标准的Java应用程序的入口方法。而这里的@SpringBootApplication则是一个组合注解,我们可以看看它的源码:

我们可以看到它组合了@SpringBootConfiguration、@EnableAutoConfiguration以及@ComponentScan,我们在开发的过程中如果不使用@SpringBootApplication,则可以组合使用这三个注解。这三个注解中,@SpringBootConfiguration实际上就是我们前面几篇博客提到的@Configuration注解,表明这个类是一个配置类,@EnableAutoConfiguration则表示让Spring Boot根据类路径中的jar包依赖为当前项目进行自动配置,最后一个@ComponentScan的作用我也不赘述了,唯一要注意的是如果我们使用了@SpringBootApplication注解的话,系统会去入口类的同级包以及下级包中去扫描实体类,因此我们建议入口类的位置在groupId+arctifactID组合的包名下。

关闭特定的自动配置

@ComponentScan注解是有一个过滤器的,如果我们只想要@SpringBootApplication去扫描特定的类而不是全部类,那么就可以关闭自动配置,如下:

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)

定制Banner,修改Banner,关闭Banner

我们第一次启动项目的时候会发现控制台上会出现一个默认的banner图案,就是下面这个

当然,这个图案如果你需要的话是可以自己修改的,修改方式很简单:

1.在src/main/resources下新建一个banner.txt文档

2.通过http://patorjk.com/software/taag网站生成需要的字符,将字符拷贝到步骤1所创建的txt文档中,比如我这里为Hello Sang!生成字符

可以修改当然也可以关闭,关闭Banner需要我们稍微修改一下main方法中的代码,如下:

public static void main(String[] args) {
        SpringApplicationBuilder builder = new SpringApplicationBuilder(Test19SpringBoot2Application.class);
        //修改Banner的模式为OFF
        builder.bannerMode(Banner.Mode.OFF).run(args);
    }

好了,上面只是一些了解的东西,下面我们来看下spring boot 的配置文件

Spring Boot使用一个全局的配置文件application.properties或者application.yml,配置文件放在src/main/resources目录下。properties是我们常见的一种配置文件,Spring Boot不仅支持properties这种类型的配置文件,也支持yaml语言的配置文件,我这里以properties类型的配置文件为例来看几个案例。

1.修改Tomcat默认端口和默认访问路径

Tomcat默认端口是8080,我将之改为8081,默认访问路径是http://localhost:8080,我将之改为http://localhost:8081/helloboot,我们来看看这两个需求要怎么样通过简单的配置来实现。

很简单,在application.properties文件中添加如下代码:

server.context-path=/helloboot
server.port=8081

然后再启动Project,在浏览器中就得这样来访问了:

2.常规属性配置

我们使用了Spring Boot,只需要在application.properties中定义属性,然后在代码中直接使用@Value注入即可。

book.author=罗贯中
book.name=三国演义
book.pinyin=sanguoyanyi
我这里专门设置了中文,因为中文不做特殊处理会乱码,处理方式为继续在application.properties中添加如下代码:

server.tomcat.uri-encoding=UTF-8
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
spring.http.encoding.force=true
spring.messages.encoding=UTF-8
然后在变量中通过@Value直接注入就行了,如下:

    @Value(value = "${book.author}")
    private String bookAuthor;
    @Value("${book.name}")
    private String bookName;
    @Value("${book.pinyin}")
    private String bookPinYin;

修改index方法,使之返回这些值:

@RequestMapping(value = "/",produces = "text/plain;charset=UTF-8")
    String index(){
        return "Hello Spring Boot! The BookName is "+bookName+";and Book Author is "+bookAuthor+";and Book PinYin is "+bookPinYin;
    }

然后启动项目在浏览器中访问即可,启动和如何访问第一节已经有讲到了这里不重复了

注意:在@Value的${}中包含的是核心配置文件中的键名。在Controller类上加@RestController表示将此类中的所有视图都以JSON方式显示,类似于在视图方法上加@ResponseBody。

下面扩展另一种方式作为了解

使用Environment方式

属性文件添加 test.msg=Hello World SpringBoot 

注意:这种方式是依赖注入Evnironment来完成,在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入,然后使用env.getProperty("键名")即可读取出对应的值。

3.类型安全的配置

刚刚说的这种方式我们在实际项目中使用的时候工作量略大,因为每个项目要注入的变量的值太多了,这种时候我们可以使用基于类型安全的配置方式,就是将properties属性和一个Bean关联在一起,这样使用起来会更加方便。我么来看看这种方式怎么实现。

1.在src/main/resources文件夹下创建文件book.properties

文件内容如下:

book.name=leon
book.author=小雷
book.price=23

2.创建Book Bean,并注入properties文件中的值

@Component
@ConfigurationProperties(prefix = "book",locations = "classpath:book.properties")
public class BookBean {
    private String name;
    private String author;
    private String price;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getPrice() {
        return price;
    }

    public void setPrice(String price) {
        this.price = price;
    }
}

prefix是指前缀,location指定要注入文件的位置。

使用@Component是让该类能够在其他地方被依赖使用,即使用@Autowired注释来创建实例。

3.添加路径映射

在Controller中添加如下代码注入Bean:

@Autowired
private BookBean bookBean;

注意:由于在Conf类上加了注释@Component,所以可以直接在这里使用@Autowired来创建其实例对象。

添加路径映射:

@RequestMapping("/book")
    public String book() {
        return "Hello Spring Boot! The BookName is "+bookBean.getName()+";and Book Author is "+bookBean.getAuthor()+";and Book price is "+bookBean.getPrice();
    }
然后启动项目在浏览器中访问就可以看到book.properties属性文件中设置的值了

下面我们说下日志配置

默认情况下Spring Boot使用Logback作为日志框架,也就是我们前面几篇博客中用到的打印日志方式,当然如果有需要我们可以手动配置日志级别以及日志输出位置,相比于我们在Spring容器中写的日志输出代码,这里的配置简直就是小儿科了,只需要在application.properties中添加如下代码:

logging.file=/home/sang/workspace/log.log
logging.level.org.springframework.web=debug

上面表示配置日志输出位置,下面配置日志级别。

Profile配置问题

 Spring常用配置 这篇文章中介绍了Profile的作用,如何在Spring框架下使用Profile,还是稍微有点麻烦,在Spring Boot 中系统提供了更为简洁的方式。全局Profile配置我们使用application-{profile}.properties来定义,然后在application.properties中通过spring.profiles.active来指定使用哪个Profile。OK,那么接下来我们来看一个简单的案例。

1.在src/main/resources文件夹下定义不同环境下的Profile配置文件,文件名分别为application-prod.properties和application-dev.properties,这两个前者表示生产环境下的配置,后者表示开发环境下的配置,如下:

application-prod.properties:

server.port=8081

application-dev.properties:

server.port=8080
然后在application.properties中进行简单配置,如下:

spring.profiles.active=dev
这个表示使用开发环境下的配置。然后运行项目,我们得通过8080端口才可以访问项目了

如果想换为生产环境,只需要把spring.profiles.active=dev改为spring.profiles.active=prod即可,当然访问端口这是也变为8081了





猜你喜欢

转载自blog.csdn.net/lchq1995/article/details/79542305