Java - 框架之 SpringBoot 攻略day01
Spring-Boot 攻略 day01
spring-boot
一. 基本配置加运行
1. 导入配置文件(pom.xml 文件中)
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.9.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
2. Application.java
@SpringBootApplication
publicclassHelloApplication{
publicstaticvoid main(String[] args){
SpringApplication.run(HelloApplication.class, args);
}
}
3. Controller.java
/*
@RestController 可以代替 @ResponseBody 和 @Controller
*/
@ResponseBody
@Controller
publicclass h1Controller {
@RequestMapping("/hello")
publicString t1(){
return"Hello!";
}
}
4. 直接运行 Application 中的代码,页面访问 http://localhost:8080/hello 就会看到 Hello!。
5. 打包 jar 包,在 pom.xml 配置文件中添加:
<!-- 这个插件,可以将应用打包成一个可执行的jar包;-->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
6.运行:
java -jar jar包名
二. SpringBoot( pom.xml )文件讲解
1. 依赖包:
都存放在 pom.xml 文件 -> spring-boot-starter-parent -> spring-boot-dependedcies 中
2. 启动器
spring-boot-starter: Spring-Boot 场景启动器。
比如上面的 **spring-boot-starter-web**就帮我们导入了有关web项目的启动器, 所以需要什么场景的starter(启动器),只需要导入相关依赖即可。
<artifactId>spring-boot-starter-web</artifactId>
三. 主程序(主入口)类
1. 注解
@SpringBootApplication :标注在某个类上说明这个类是 SpringBoot 的主配置类,SpringBoot 可以运行这个类的 main 方法来启动服务。
@SpringBootApplication
publicclassHelloApplication{
publicstaticvoid main(String[] args){
SpringApplication.run(HelloApplication.class, args);
}
}
@SpringBootConfiguration :Spring Boot的配置类;
@Configuration :配置类标注这个注解(配置文件;配置类也是容器中的一个组件;@Component)
@EnableAutoConfiguration :开启自动配置功能;
@AutoConfigurationPackage :自动配置包;
@Import(EnableAutoConfigurationImportSelector.class) : 给容器中导入组件;
四. 使用 Spring Initializer 快速创建 Spring Boot 项目
1. 创建 Spring Initializer 项目,并选择需要使用的模块。
2. resources 文件夹中目录结构
- static : 静态资源
- templates :模板页面
- application.properties : SpringBoot 应用的配置文件
五. 配置文件(两者都可配置,写法不同)
1. application.properties
- 写法:
server.port=8081
2. application.yml (默认没有,需手动创建到 resources 文件下)
- 写法
server:
port:8081
3. YMAL 基本语法
- 以空格缩进
server:
port:8081
值的写法
- 字面量:k: v 的方式来写(注意有个空格在:的后面)
"" :双引号不会转义特殊字符
'' : 单引号会转移特殊字符(转义为字符串)
- 字面量:k: v 的方式来写(注意有个空格在:的后面)
对象,Map 写法
k: v 与上面写法一致
server:
port:8081
行内表示:
server:{port:8081}
数组 (List, Set)
Person:
- p1
- p2
- p3
4. 配置文件的注入
注意:这个配置顺序要写在单元测试配置之前
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processo</artifactId>
<optional>true</optional>
</dependency>
一. yaml 配置
- application.yml
lastname:张三
age:11
isBoy:true
Date:2019/4/19
maps:{k1: v1, k2:59}
lists:
- li1
- li2
dog:
name:黑狗
age:1
- Person.java
/*
* 将配置文件中配置的每一个属性值,映射到这个组件中
* @ConfigurationProperties:告诉 SpringBoot 将当前类中的所有属性与 配置文件中的配置进行帮定
* prefix = "person" : 配置文件中哪个下面的所有属性进行映射
*
* 只有这个组件是容器中的组件,才能提供 @ConfigurationProperties 中的功能,也就是需要加上:@Component
* */
@Component
@ConfigurationProperties(prefix ="person")
publicclassPerson{
privateString lastName;
privateInteger age;
privateBoolean isBoy;
privateDate birthday;
privateMap<Object,Object> maps;
privateList<Object> lists;
privateDog dog;
}
- Dog.java
publicclassDog{
privateString name;
privateInteger age;
}
- Test 单元测试
@Autowired
Person person;
@Test
publicvoid contextLoads(){
System.out.println(person);
}
二. properties 配置 ( application.properties )
注意:使用这个配置会有编码问题,解决如下( idea ):
settings -> File Encodings 配置下:
Default encoding for properties files: 设置为 UTF-8
勾选:Transparent native-to-ascii conversion 这个选项
- application.properties 文件
# 配置 Person 的值
person.last-name=张三
person.age=11
person.birthday=2019/4/19
person.isBoy=true
person.maps.k1=v1
person.maps.k2=59
person.lists=p1,p2,p3
person.dog.name=大黑狗
person.dog.age=2
- 剩余配置如上
三. @ConfigurationProperties 与 @Value
比较 | @ConfigurationProperties | @Value |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
松散绑定(松散语法) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
- 松散绑定 :如果遇到 last-name 可以写成 lastName,也就是带有 - 或 _ 的后一个字母可用大写
- SpEL : 语法解析,如 ${1*19} , @Value 就可以解析
- JSR303数据校验 : 内置的 @Eamil 等可以进行数据的校验,详细请看下文
- 复杂类型封装 :如 Map 等复杂类型 @Value 是无法解析的(List可以解析),会报错
@Component
//@ConfigurationProperties(prefix = "person")
@Validated
publicclassPerson{
// @Value("${person.last-name}")
@Email// 这里 lastName 必须是邮箱格式
privateString lastName;
@Value("#{1*10}")// 可进行逻辑操作
privateInteger age;
privateBoolean isBoy;
privateDate birthday;
privateMap<Object,Object> maps;
privateList<Object> lists;
privateDog dog;
}
四. @PropertySource & @ImportResource & @Bean
@PropertySource:加载指定的配置文件;
/**
*
* @PropertySource : 可以指定到去哪个文件加载配置
*/
@PropertySource(value ={"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix ="person")
//@Validated
publicclassPerson{
/**
* <bean class="Person">
* <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
* <bean/>
*/
//lastName必须是邮箱格式
// @Email
//@Value("${person.last-name}")
privateString lastName;
//@Value("#{11*2}")
privateInteger age;
//@Value("true")
privateBoolean boss;
}
@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上
@ImportResource(locations ={"classpath:beans.xml"})
导入Spring的配置文件让其生效
使用XML文件加载配置(beans.xml)
<?xml version="1.0" encoding="UTF-8"?>
<beansxmlns="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">
<beanid="helloService"class="com.atguigu.springboot.service.HelloService"></bean>
</beans>
SpringBoot推荐给容器中添加组件的方式:使用全注解
1、配置类@Configuration------>Spring配置文件
2、使用@Bean给容器中添加组件
- Service.java
// @Configuration :指明当前类为配置类,用来替代 Spring 配置文件
@Configuration
publicclassMyAppConfig{
// @Bean :将方法的返回值添加到容器中,容器中这个组件的默认id就是方法名
@Bean
publicHelloService helloService(){
returnnewHelloService();
}
}
- 单元测试类
@Autowired
ApplicationContext ioc;
@Test
publicvoid testHelloService(){
System.out.println("执行配置文件...");
boolean b = ioc.containsBean("helloService");
System.out.println(b);
}
五. 配置文件占位符
1、随机数
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
2、占位符获取之前配置的值,如果没有可以是用:指定默认值
person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15
六. Profile
1、多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置;
2、yml支持多文档块方式
server:
port:8081
spring:
profiles:
active: prod
---
server:
port:8083
spring:
profiles: dev
---
server:
port:8084
spring:
profiles: prod #指定属于哪个环境
3、激活指定profile
1、在配置文件中指定 spring.profiles.active=dev
2、命令行:
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
可以直接在测试的时候,配置传入命令行参数
3、虚拟机参数;
-Dspring.profiles.active=dev
七、配置文件加载位置
springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/
–file:./
–classpath:/config/
–classpath:/
优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件;互补配置;
==我们还可以通过spring.config.location来改变默认的配置文件位置==
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
八、外部配置加载顺序
==SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置==
1.命令行参数
所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多个配置用空格分开; --配置项=值
2.来自java:comp/env的JNDI属性
3.Java系统属性(System.getProperties())
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性值
==由jar包外向jar包内进行寻找;==
==优先加载带profile==
6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
==再来加载不带profile==
8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10.@Configuration注解类上的@PropertySource
11.通过SpringApplication.setDefaultProperties指定的默认属性
所有支持的配置加载来源;
8、自动配置原理
配置文件到底能写什么?怎么写?自动配置原理;
1、自动配置原理:
1)、SpringBoot启动的时候加载主配置类,开启了自动配置功能 ==@EnableAutoConfiguration==
2)、@EnableAutoConfiguration 作用:
利用EnableAutoConfigurationImportSelector给容器中导入一些组件?
可以查看selectImports()方法的内容;
List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
SpringFactoriesLoader.loadFactoryNames()
扫描所有jar包类路径下 META-INF/spring.factories
把扫描到的这些文件的内容包装成properties对象
从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器中
==将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中;==
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,
...
每一个这样的 xxxAutoConfiguration类都是容器中的一个组件,都加入到容器中;用他们来做自动配置;
3)、每一个自动配置类进行自动配置功能;
4)、以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;
@Configuration//表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class)//启动指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中
@ConditionalOnWebApplication//Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是,当前配置类生效
@ConditionalOnClass(CharacterEncodingFilter.class)//判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器;
@ConditionalOnProperty(prefix ="spring.http.encoding", value ="enabled", matchIfMissing =true)//判断配置文件中是否存在某个配置 spring.http.encoding.enabled;如果不存在,判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true,也是默认生效的;
publicclassHttpEncodingAutoConfiguration{
//他已经和SpringBoot的配置文件映射了
privatefinalHttpEncodingProperties properties;
//只有一个有参构造器的情况下,参数的值就会从容器中拿
publicHttpEncodingAutoConfiguration(HttpEncodingProperties properties){
this.properties = properties;
}
@Bean//给容器中添加一个组件,这个组件的某些值需要从properties中获取
@ConditionalOnMissingBean(CharacterEncodingFilter.class)//判断容器没有这个组件?没有才加载
publicCharacterEncodingFilter characterEncodingFilter(){
CharacterEncodingFilter filter =newOrderedCharacterEncodingFilter();
filter.setEncoding(this.properties.getCharset().name());
filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
return filter;
}
根据当前不同的条件判断,决定这个配置类是否生效?
一但这个配置类生效;这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取的,这些类里面的每一个属性又是和配置文件绑定的;
5)、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘;配置文件能配置什么就可以参照某个功能对应的这个属性类
@ConfigurationProperties(prefix ="spring.http.encoding")//从配置文件中获取指定的值和bean的属性进行绑定
publicclassHttpEncodingProperties{
publicstaticfinalCharset DEFAULT_CHARSET =Charset.forName("UTF-8");
精髓:
1)、SpringBoot启动会加载大量的自动配置类
2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)
4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfigurartion:自动配置类;
给容器中添加组件
xxxxProperties:封装配置文件中相关属性;
2、细节
1、@Conditional派生注解(Spring注解版原生的@Conditional作用)
作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
@Conditional扩展注解 | 作用(判断是否满足当前指定条件) |
---|---|
@ConditionalOnJava | 系统的java版本是否符合要求 |
@ConditionalOnBean | 容器中存在指定Bean; |
@ConditionalOnMissingBean | 容器中不存在指定Bean; |
@ConditionalOnExpression | 满足SpEL表达式指定 |
@ConditionalOnClass | 系统中有指定的类 |
@ConditionalOnMissingClass | 系统中没有指定的类 |
@ConditionalOnSingleCandidate | 容器中只有一个指定的Bean,或者这个Bean是首选Bean |
@ConditionalOnProperty | 系统中指定的属性是否有指定的值 |
@ConditionalOnResource | 类路径下是否存在指定资源文件 |
@ConditionalOnWebApplication | 当前是web环境 |
@ConditionalOnNotWebApplication | 当前不是web环境 |
@ConditionalOnJndi | JNDI存在指定项 |
自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
==我们可以通过启用 debug=true属性;来让控制台打印自动配置报告==,这样我们就可以很方便的知道哪些自动配置类生效;
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:(自动配置类启用的)
-----------------
DispatcherServletAutoConfiguration matched:
-@ConditionalOnClass found required class'org.springframework.web.servlet.DispatcherServlet';@ConditionalOnMissingClass did not find unwanted class(OnClassCondition)
-@ConditionalOnWebApplication(required) found StandardServletEnvironment(OnWebApplicationCondition)
Negative matches:(没有启动,没有匹配成功的自动配置类)
-----------------
ActiveMQAutoConfiguration:
Did not match:
-@ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory','org.apache.activemq.ActiveMQConnectionFactory'(OnClassCondition)
AopAutoConfiguration:
Did not match:
-@ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect','org.aspectj.lang.reflect.Advice'(OnClassCondition)
Java - 框架之 SpringBoot 攻略day01的更多相关文章
- java框架之SpringBoot(1)-入门
简介 Spring Boot 用来简化 Spring 应用开发,约定大于配置,去繁从简,just run 就能创建一个独立的.产品级别的应用. 背景: J2EE 笨重的开发.繁多的配置.低下的开发效率 ...
- java框架之SpringBoot(3)-日志
市面上的日志框架 日志抽象层 日志实现 JCL(Jakarta Commons Logging).SLF4J(Simple Logging Facade For Java).JBoss-Logging ...
- java框架之SpringBoot(4)-资源映射&thymeleaf
资源映射 静态资源映射 查看 SpringMVC 的自动配置类,里面有一个配置静态资源映射的方法: @Override public void addResourceHandlers(Resource ...
- java框架之SpringBoot(5)-SpringMVC的自动配置
本篇文章内容详细可参考官方文档第 29 节. SpringMVC介绍 SpringBoot 非常适合 Web 应用程序开发.可以使用嵌入式 Tomcat,Jetty,Undertow 或 Netty ...
- java框架之SpringBoot(7)-异常处理
前言 在 SpringBoot 项目中,默认情况下,使用浏览器访问一个不存在的地址会返回如下错误页面: 而当客户端未非浏览器时,错误信息则会以 json 数据返回,如下: 会出现如上效果的原因是 Sp ...
- java框架之SpringBoot(14)-任务
使用 maven 创建 SpringBoot 项目,引入 Web 场景启动器. 异步任务 1.编写异步服务类,注册到 IoC 容器: package zze.springboot.task.servi ...
- java框架之SpringBoot(15)-安全及整合SpringSecurity
SpringSecurity介绍 Spring Security 是针对 Spring 项目的安全框架,也是 Spring Boot 底层安全模块默认的技术选型.它可以实现强大的 Web 安全控制.对 ...
- java框架之SpringBoot(16)-分布式及整合Dubbo
前言 分布式应用 在分布式系统中,国内常用 Zookeeper + Dubbo 组合,而 SpringBoot 推荐使用 Spring 提供的分布式一站式解决方案 Spring + SpringBoo ...
- 【java框架】SpringBoot(5)--SpringBoot整合分布式Dubbo+Zookeeper
1.理论概述 1.1.分布式 分布式系统是若干独立计算机的集合,这些计算机对于用户来讲就像单个系统. 由多个系统集成成一个整体,提供多个功能,组合成一个板块,用户在使用上看起来是一个服务.(比如淘宝网 ...
随机推荐
- (七)linux 学习 -- 键盘高级操作技巧
The Linux Command Line 读书笔记 - 部分内容来自 http://billie66.github.io/TLCL/book/chap09.html 文章目录 移动光标 修改文本 ...
- c++ map容器使用及问题
C++ STL库map容器一些总结,欢迎大家指正补充. map容器由两部分组成,分别为关键字(Key)和值(Value),关键字和值都可以声明为任意类型的数据,注意:关键字唯一,不能重复!使用需包含头 ...
- python学习-63 组合
组合 1.什么是组合? 定义一个类,由数据属性构成,这几个属性又可以是通过一个类实例化的对象,这就是组合. 举例: class School: def __init__(self,name,addre ...
- logrus 剖析之 formatter
使用 logrus 通过 formatter 来定义输出日志的格式,具体例子如下: package main import ( log "github.com/Sirupsen/logrus ...
- TypeScript之接口
1.写法 // 属性 interface Person { name:string; age:number; hobby: string; } // 函数 interface { todo(para ...
- vue 项目中assets 和static的区别
一.Webpacked Assets 为了回答这个问题,我们首先需要了解Webpack如何处理静态资产.在 *.vue 组件中,所有模板和CSS都会被 vue-html-loader 及 css-lo ...
- WebSocket简单使用
很简单就不写太多介绍了,仅展示服务端代码!! Configure在Startup类的方法中添加WebSockets中间件 app.UseWebSockets(); 可以配置以下设置: KeepAliv ...
- NEST 根据id查询
想要在NEST里根据id查询 GET /employee/employee/1 可使用Get方法 public IGetResponse<employee> GetDoc() { var ...
- 【洛谷 P4137】 Rmq Problem / mex(主席树)
题目链接 容易发现,可能答案只有\(0\).每个数,每个数\(+1\) 于是把这\(2n+1\)个数建立一个权值线段树,可持久化一下,每个节点记录这个子树中最后加入数加入的时间的最小值\(latest ...
- 从Iterator到async/await
Generator和Async 引言 接触过Ajax请求的会遇到过异步调用的问题,为了保证调用顺序的正确性,一般我们会在回调函数中调用,也有用到一些新的解决方案如Promise相关的技术. 在异步编程 ...