Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。通过这种方式,Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。
以下是我个人编写的SpringBoot简明教程,方便初学者学习,如有不足,敬请指正。
首先,我们需要用idea创建一个SpringBoot项目。
然后,来一个HelloWorld快速入门。
1.HelloWorld
如何快速搭建自己的第一个服务,步骤如下。 这里创建一个包,叫controller,代表控制器的意思。然后在里面新建一个ViewController,代表视图控制器。
代码如下:
package com.java18.vipmgr.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; @Controller public class ViewController { @RequestMapping("hello") @ResponseBody public String Hello(){ return "Hello SpringBoot!"; } }
重新启动项目,即运行这个类: 浏览器访问:http://localhost:8080/hello
即可看到:
做到这一步,HelloWorld就完成了,恭喜你,成功踏入了学习SpringBoot的第一步!
springboot 读取 yml 配置的几种方式
SpringBoot项目的配置文件,我们习惯采用yml格式, yml 文件规则如下:
yml文件的好处,天然的树状结构,一目了然,实质上跟properties是差不多的。
不支持tab缩进
可以使用 "-小写字母" 或 "_小写字母"来 代替 "大写字母",如 userName 与 user-name ,user_name 含义是一样的
key: value 格式书写 key 后面跟着冒号,再后面跟着一个空格,然后是值。
几种数据格式的表示方式
1.普通的值(数字,字符串,布尔)
2.对象、Map (属性和值) (键值对)
3.数组 (List、Set)
普通的值(数字,字符串,布尔) 直接就是 key: value ,如:
age: 18 name: mysgk
字符串默认不用加上单引号或者双引号; "":双引号不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思 例子: name: "zhangsan \n lisi":输出;zhangsan 换行 lisi '':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据 name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi
对象、Map(属性和值)(键值对)
对象还是k: v的方式
k: v:在下一行来写对象的属性和值的关系;注意缩进(不支持tab,使用空格),如:
person: age: 18 name: mysgk
数组(List、Set)
用- 值表示数组中的一个元素,如:
hands: - left - right
第一种读取方式@value
如果我们只需要配置文件中的一两个值,@Value 是最简单方便的方式.
server: port: 8081
我们在代码中可以这样取值
@Value("${server.port}") public String port;
注:此处的prot 所在的类需要是一个组件,如果是实体类需要加上@Component
,否则配置不会自动注入的。
第二种读取方式@ConfigurationProperties
如果需要一个JavaBean 来专门映射配置的话,我们一般会使用@ConfigurationProperties
来读取。
student: age: 18 name: mysgk
javabean:
@Component @ConfigurationProperties(prefix = "student") public class Student { private String name; private Integer age; public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } @Override public String toString() { return "Student{" + "name='" + name + '\'' + ", age=" + age + '}'; } }
使用@ConfigurationProperties
,需要配置一个prefix (前缀) 参数, 即写上 key 就可以了.
第三种读取方式@Environment
这种方法好像用的比较少,基本没用过...
test: msg: aaa
代码:
@Autowired private Environment env @RequestMapping(value = "index2", method = RequestMethod.GET) public String index2() { System.out.println(env.getProperty("test.msg")); return "The Way 2 : "+ env.getProperty("test.msg"); }
验证1.@Value方式
在启动类同级目录添加一个pojo包,里面新建一个Cat类。
创建application.yml文件
Cat类结构如下
public class Cat { private String name; private int sex; private List<String> hobbies; }
对应的yml配置文件
public class Cat { private String name; private int sex; private List<String> hobbies; }
给Cat类加上自动注入
@Component public class Cat { @Value("${cat.name}") private String name; @Value("${cat.sex}") private int sex; private List<String> hobbies; @Override public String toString() { return "Cat{" + "name='" + name + '\'' + ", sex=" + sex + ", hobbies=" + hobbies + '}'; } }
测试:
@SpringBootTest class VipMgrApplicationTests { @Autowired Cat cat; @Test void contextLoads() { System.out.println(cat); } }
结果:
Cat{name='机器猫', sex=1, hobbies=null}
list类型的用这种方式注入有点复杂,推荐下一种方式。
验证2 @ConfigurationProperties方式
@Component @ConfigurationProperties(prefix = "cat" ) public class Cat { private String name; private int sex; private List<String> hobbies; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getSex() { return sex; } public void setSex(int sex) { this.sex = sex; } public List<String> getHobbies() { return hobbies; } public void setHobbies(List<String> hobbies) { this.hobbies = hobbies; } @Override public String toString() { return "Cat{" + "name='" + name + '\'' + ", sex=" + sex + ", hobbies=" + hobbies + '}'; } }
注意,这种方式一定要加上对应的get set方法,不然注入不了。
很明显,这种方式比@Value清爽太多了。
spring boot Configuration Annotation Proessor not found in classpath
上面那种方法,会提示这个错误
打开右上角的文档,又提示404,无语。
Springboot1.5以上版本,在使用 @ConfigurationProperties注解的时候会提示“Spring Boot Configuration Annotation Processor not found in classpath”,
这是因为新版本已经取消了对location的支持,替代方案是使用 @Configuration和@PropertySource进行组合使用,例如: @Primary @Configuration @PropertySource(value = "classpath:application.properties", ignoreResourceNotFound = true) 如果要使用指定属性前缀”Prefix“,这时候还会使用到@ConfigurationProperties,提示依然会存在
解决办法是添加这个依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
然后maven -- reload,解决问题!
强大的yml文件
yml文件提供很多强大的特性,推荐使用。
1. 变量复用
就是在配置文件中用${xxx}调用其他变量,如
cat: name: 机器猫 sex: 1 hobbies: - 吃铜锣烧 - 和小咪聊天 - 用竹蜻蜓飞天 nameAndSex: ${cat.name},性别是${cat.sex}
增加nameAndSex属性
private String nameAndSex; public String getNameAndSex() { return nameAndSex; } public void setNameAndSex(String nameAndSex) { this.nameAndSex = nameAndSex; }
测试
@SpringBootTest class VipMgrApplicationTests { @Autowired Cat cat; @Test void contextLoads() { System.out.println(cat.getNameAndSex()); } }
结果:机器猫,性别是1
2. 随机函数
yml文件中可生成很多随机数,如UUID,随机数字等。
例:
name: 机器猫${random.int[1,100]}
得到的就是这样的: 机器猫91,性别是1
3.设置默认值
cat: name: 机器猫${random.int[1,100]} #sex: hobbies: - 吃铜锣烧 - 和小咪聊天 - 用竹蜻蜓飞天 nameAndSex: ${cat.name},性别是${cat.sex:男}
sex被注掉了,${cat.sex:男}就代表如果sex没有,就默认是男。