← 返回学习路线

SYSTEM

配置文件

Java基础配置文件system
src/content/notes/system/配置文件.md

配置文件

配置方式

文件类型

SpringBoot 是基于约定的,很多配置都有默认值,如果想使用自己的配置替换默认配置,可以使用 application.properties 或者 application.yml(application.yaml)进行配置

  • 默认配置文件名称:application
  • 在同一级目录下优先级为:properties > yml > yaml

例如配置内置 Tomcat 的端口

  • properties:

    server.port=8080
  • yml:

    server: port: 8080
  • yaml:

    server: port: 8080

加载顺序

所有位置的配置文件都会被加载,互补配置,高优先级配置内容会覆盖低优先级配置内容

扫描配置文件的位置按优先级从高到底:

  • file:./config/:当前项目下的 /config 目录下

  • file:./:当前项目的根目录,Project工程目录

  • classpath:/config/:classpath 的 /config 目录

  • classpath:/:classpath 的根目录,就是 resoureces 目录

项目外部配置文件加载顺序:外部配置文件的使用是为了对内部文件的配合

  • 命令行:在 package 打包后的 target 目录下,使用该命令

    java -jar myproject.jar --server.port=9000
  • 指定配置文件位置

    java -jar myproject.jar --spring.config.location=e://application.properties
  • 按优先级从高到底选择配置文件的加载命令

    java -jar myproject.jar

yaml语法

基本语法:

  • 大小写敏感

  • 数据值前边必须有空格,作为分隔符

  • 使用缩进表示层级关系

  • 缩进时不允许使用Tab键,只允许使用空格(各个系统 Tab对应空格数目可能不同,导致层次混乱)

  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

  • ”#” 表示注释,从这个字符一直到行尾,都会被解析器忽略

    server: 
    	port: 8080  
        address: 127.0.0.1

数据格式:

  • 纯量:单个的、不可再分的值

    msg1: 'hello \n world'  # 单引忽略转义字符
    msg2: "hello \n world"  # 双引识别转义字符
  • 对象:键值对集合,Map、Hash

    person:  
       name: zhangsan
       age: 20
    # 行内写法
    person: {name: zhangsan}

    注意:不建议使用 JSON,应该使用 yaml 语法

  • 数组:一组按次序排列的值,List、Array

    address:
      - beijing
      - shanghai
    # 行内写法
    address: [beijing,shanghai]
    allPerson	#List<Person>
      - {name:lisi, age:18}
      - {name:wangwu, age:20}
    # 行内写法
    allPerson: [{name:lisi, age:18}, {name:wangwu, age:20}]
  • 参数引用:

    name: lisi 
    person:
      name: ${name} # 引用上边定义的name值

获取配置

三种获取配置文件的方式:

  • 注解 @Value

    @RestController
    public class HelloController {
        @Value("${name}")
        private String name;
    
        @Value("${person.name}")
        private String name2;
    
        @Value("${address[0]}")
        private String address1;
    
        @Value("${msg1}")
        private String msg1;
    
        @Value("${msg2}")
        private String msg2;
        
        @RequestMapping("/hello")
        public String hello(){
            System.out.println("所有的数据");
            return " hello Spring Boot !";
        }
    }
  • Evironment 对象

    @Autowired
    private Environment env;
    
    @RequestMapping("/hello")
    public String hello() {
        System.out.println(env.getProperty("person.name"));
        System.out.println(env.getProperty("address[0]"));
        return " hello Spring Boot !";
    }
  • 注解 @ConfigurationProperties 配合 @Component 使用

    注意:参数 prefix 一定要指定

    @Component	//不扫描该组件到容器内,无法完成自动装配
    @ConfigurationProperties(prefix = "person")
    public class Person {
        private String name;
        private int age;
        private String[] address;
    }
    @Autowired
    private Person person;
    
    @RequestMapping("/hello")
    public String hello() {
        System.out.println(person);
        //Person{name='zhangsan', age=20, address=[beijing, shanghai]}
        return " hello Spring Boot !";
    }

配置提示

自定义的类和配置文件绑定一般没有提示,添加如下依赖可以使用提示:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

<!-- 下面插件作用是工程打包时,不将spring-boot-configuration-processor打进包内,让其只在编码的时候有用 -->
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-configuration-processor</artifactId>
                    </exclude>
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>

Profile

@Profile:指定组件在哪个环境的情况下才能被注册到容器中,不指定,任何环境下都能注册这个组件

  • 加了环境标识的 bean,只有这个环境被激活的时候才能注册到容器中,默认是 default 环境
  • 写在配置类上,只有是指定的环境的时候,整个配置类里面的所有配置才能开始生效
  • 没有标注环境标识的 bean 在,任何环境下都是加载的

Profile 的配置:

  • profile 是用来完成不同环境下,配置动态切换功能

  • profile 配置方式:多 profile 文件方式,提供多个配置文件,每个代表一种环境

    • application-dev.properties/yml 开发环境
    • application-test.properties/yml 测试环境
    • sapplication-pro.properties/yml 生产环境
  • yml 多文档方式:在 yml 中使用 --- 分隔不同配置

    ---
    server:
      port: 8081
    spring:
      profiles:dev
    ---
    server:
      port: 8082
    spring:
      profiles:test
    ---
    server:
      port: 8083
    spring:
      profiles:pro
    ---
  • profile 激活方式

    • 配置文件:在配置文件中配置:spring.profiles.active=dev

      spring.profiles.active=dev
    • 虚拟机参数:在VM options 指定:-Dspring.profiles.active=dev

    • 命令行参数:java –jar xxx.jar --spring.profiles.active=dev

      在 Program arguments 里输入,也可以先 package


Web开发

功能支持

SpringBoot 自动配置了很多约定,大多场景都无需自定义配置

  • 内容协商视图解析器 ContentNegotiatingViewResolver 和 BeanName 视图解析器 BeanNameViewResolver
  • 支持静态资源(包括 webjars)和静态 index.html 页支持
  • 自动注册相关类:Converter、GenericConverter、Formatter
  • 内容协商处理器:HttpMessageConverters
  • 国际化:MessageCodesResolver

开发规范:

  • 使用 @Configuration + WebMvcConfigurer 自定义规则,不使用 @EnableWebMvc 注解
  • 声明 WebMvcRegistrations 的实现类改变默认底层组件
  • 使用 @EnableWebMvc + @Configuration + DelegatingWebMvcConfiguration 全面接管 SpringMVC