个人博客:haichenyi.com。感谢关注
用IDEA可以直接创建SpringBoot项目,创建Moudle的时候,在选Maven的地方,选择Sping Initializr即可,很简单。前面讲过了IDEA生成Maven项目,并且嵌入SpringBoot,直接创建Spring Boot项目就是IDEA直接帮我们依赖,并且生成Application和properties文件。其它,也没啥大的区别,就不多说了。
本篇要讲的是SpringBoot的配置文件,分为两种:
- properties
- yml
之前,搜SpringBoot的配置文件怎么写的时候,看到网上很多博客都有文件内容,但是有两种写法,就是这两种配置文件的不同写法。
举个栗子,我现在要修改服务器启动的端口号,用properties怎么修改呢?很简单:
properties修改端口号.png如上图所示,是不是很简单?
server.port=8081
用yml怎么修改呢?也不难:
yml修改端口号.png如上图所示:也不难
server:
port: 808
看到了上面两个图片,应该也已经发现了,两个配置文件存放位置都在resource目录下面。或者在类路径的"/config"路径下
这两种写法要怎么写呢?
properties: 等号连接,右边是值
yml:key:
- value 表示一对键值对(冒号后面必须要有空格)
- 使用空格缩进表示层级关系
- 左侧缩进的空格数目不重要,只要同一层级的元素左侧对齐即可
- key 与 value 大小写敏感
PS: yml不管是存map,还是list,都要记得key后面的冒号一定要跟空格,再写值
举个栗子,我们定义一个bean类,在配置文件里面赋值,在项目里面取出来用。比方说:我们项目里面定义一个Userbean类。
package com.haichenyi.springboot.pojo;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Data
@Component
@ConfigurationProperties(prefix = "user")
public class User {
private String username;
private String nickname;
private String password;
private Integer age;
}
这里有几点需要注意:
- 这里的bean类,必须要有写set/get方法,不然赋不了值,我这里没写是因为我用的@Data这个注解,它默认帮我们创建了set/get方法
- @ConfigurationProperties注解就是 告诉SpringBoot将配置文件中对应属性的值,映射到这个组件类中,进行一 一绑定,prefix = "user"的作用就是配置文件中的前缀名,哪个前缀与下面的所有属性进行一一映射
- @Component 注解就是将当前组件也就是这个bean类作为SpringBoot中的一个组件,才能使用容器提供的
然后就是在配置文件中赋值,properties或者是yml,都可以:
properties中:
server.port=8081
user.username=s19734682s
user.age=20
user.password=123456
user.nickname=林汐痕
yml中:
server:
port: 8088
//这个user就是上面说的配置文件中的前缀名
user:
nickname: 海晨忆
username: pk19734682
password: 123456
age: 18
怎么使用呢?直接在controller中用这个user就可以了
package com.haichenyi.springboot.controller;
import com.haichenyi.springboot.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class SayController {
@Autowired
private User user;
@ResponseBody
@RequestMapping("/say")
public String say() {
return "hello " +user;
}
}
就这样,请求这个接口就能打印值。
还有通过@Value指定值的方式
@Controller
public class SayController {
@Value("${user.nickname}")
private String nickname;
@ResponseBody
@RequestMapping("/say")
public String say() {
return "hello " + nickname;
}
}
@PropertySource 加载局部配置文件
什么叫加载局部配置文件呢?就是加载指定的配置文件,并不是从properties或者是yml中加载。怎么加载呢?如下图:
局部配置文件.png第一步, 在resources目录下创建xxx.properties/xxx.yml,这个xxx你自己命名。我这里创建的是user.properties/user.yml。记得语法不要写错了
第二步, 在你的组件的地方加上@PropertySource注解。图上有,可以导入多个局部配置,用逗号隔开,每个局部配置的写法就是 "classpath:文件名" 之前导入全局的配置的时候加的注解也需要,不能删除。
第三步, 之前是怎么使用的,现在还是怎么使用。
@ImportResource加载xml配置文件
Spring Boot框架并不推荐用xml加载配置文件,这个是Spring加载文件的方式。项目中如果必须要用到xml加载文件,要怎么办呢?
举个栗子:我要加载一个Service类到项目中。Spring Boot有注解可以直接使用,这里,我们通过xml加载。
第一步, 创建一个service。
package com.haichenyi.springboot.service;
public class UserService {
public void say() {
System.out.println("xml...");
}
}
第二步, 在resources目录下,创建spring config的xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="userService" class="com.haichenyi.springboot.service.UserService"></bean>
</beans>
如上,添加了一个bean类,两个属性,id和class。class指向刚才创建的类,id用于获取这个类。
第三步, 在我们的引导类中加上 @ImportResource 注解
package com.haichenyi.springboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;
@ImportResource(locations = "classpath:springboot01.xml")
@SpringBootApplication
public class SpringBootInitApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootInitApplication.class, args);
}
}
第四步, 通过ApplicationContext的getBean方法获取,传的参数就是在xml中定义的id。如下:
package com.haichenyi.springboot;
import com.haichenyi.springboot.pojo.User;
import com.haichenyi.springboot.service.UserService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootInitApplicationTests {
@Autowired
User user;
@Test
public void contextLoads() {
System.out.println(user);
}
@Autowired
ApplicationContext context;
@Test
public void textXml() {
UserService userService = (UserService) context.getBean("userService");
userService.say();
}
}
自定义配置类向容器中注入组件(SpringBoot推荐)
举个栗子:跟上面xml的例子一样。
第一步, 跟上面一样,创建一个service
第二步, 创建配置类:
package com.haichenyi.springboot.custom;
import com.haichenyi.springboot.service.UserService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class UserConfig {
@Bean
public UserService userService2() {
return new UserService();
}
}
需要注意的地方:
- @Configuration 用于标识当前类是一个配置类,用来表示对应spring配置文件
- @Bean 标识的方法用于向容器注入组件
- 方法的返回值就是注入容器中的组件对象
- 方法名是这个组件对象的 id值
第三步, 就是使用了,跟上面第四步一样。不需要上面的第三步。
Profile多环境支持
profile是Sping用来针对不同的环境要求,提供不同的配置支持。什么不同的环境呢?比方说:开发环境,生产环境。
全局 Profile 配置使用的文件名可以是
application-{profile}.properties / application-{profile}.yml 。如:application-dev.properties / application-prod.properties
举个栗子:
我们的项目环境分为 开发 (dev)和 生产(prod)环境 ,开发环境下端口号为 8081,
生产环境下端口号为8082。
通过properties文件指定
profile-properties.png如上图,创建了两个文件:application-dev.properties,application-prod.properties,里面内容很简单,就是指定端口号。server.port=8081
然后,我们在application.properties文件中指定激活哪一个文件即可。
//激活application-dev.properties配置
spring.profiles.active=dev
//激活application-prod.properties配置
spring.profiles.active=prod
通过yml文件指定
不用新建文件,直接在application.yml写就可以了。
PS:需要用三个减号隔开,表示不同的文档块。
spring:
profiles:
active: prod #激活哪个profile , 当前激活的是 prod 开发环境
---
server:
port: 8081
spring:
profiles: dev #指定属于哪个环境, dev 环境时使用
---
server:
port: 8081
spring:
profiles: prod #指定属于哪个环境, prod 环境时使用
网友评论