文章收集在 GitHub JavaEgg 中,歡迎star+指導
JavaEgg——《“Java技術員”成長手冊》,包含Java基礎、框架、儲存、搜尋、優化、分散式等必備知識,N線網際網路開發必備技能兵器譜。
筆記來源 尚矽谷教學筆記
一、Hello Spring Boot
1、Spring Boot 簡介
- 簡化Spring應用開發的一個框架;
- 整個Spring技術棧的一個大整合;
- J2EE開發的一站式解決方案;
2、微服務
- 微服務:架構風格(服務微化)
- 一個應用應該是一組小型服務;可以通過HTTP的方式進行互通;
- 單體應用:ALL IN ONE
- 微服務:每一個功能元素最終都是一個可獨立替換和獨立升級的軟體單元; 詳細參照微服務文件
3、環境準備
- jdk1.8:Spring Boot 推薦jdk1.7及以上;java version "1.8.0_112"
- maven3.x:maven 3.3以上版本;Apache Maven 3.3.9
- IntelliJIDEA、STS
- SpringBoot 2.2.2.RELEASE; 統一環境;
3.1、MAVEN設定;
給maven 的settings.xml配置檔案的profiles標籤新增
<profile>
<id>jdk‐1.8</id>
<activation>
<activeByDefault>true</activeByDefault>
<jdk>1.8</jdk>
</activation>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
</properties>
</profile>
複製程式碼
3.2、IDEA設定
整合maven進來
3.3、Spring Boot HelloWorld
實現一個小功能:瀏覽器傳送hello請求,伺服器接受請求並處理,響應Hello World字串;
1、建立一個maven工程;(jar)
2、匯入spring boot相關的依賴
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐parent</artifactId>
<version>2.2.2.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
</dependency>
</dependencies>
複製程式碼
3、編寫一個主程式;啟動Spring Boot應用
/**
* @SpringBootApplication 來標註一個主程式類,說明這是一個Spring Boot應用
*/
@SpringBootApplication
public class HelloWorldMainApplication {
public static void main(String[] args) {
// Spring應用啟動起來
SpringApplication.run(HelloWorldMainApplication.class,args);
}
}
複製程式碼
4、編寫相關的Controller、Service
@Controller
public class HelloController {
@ResponseBody
@RequestMapping("/hello")
public String hello(){
return "Hello World!";
}
}
複製程式碼
5、執行主程式main方法,測試
6、簡化部署
<!‐‐ 這個外掛,可以將應用打包成一個可執行的jar包;‐‐>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐maven‐plugin</artifactId>
</plugin>
</plugins>
</build>
複製程式碼
將這個應用打成jar包,直接使用java -jar的命令進行執行java -jar HelloWorldMainApplication.jar
3.4、Hello World探究
3.4.1、POM檔案
-
父專案
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐starter‐parent</artifactId> <version>2.2.2.RELEASE</version> </parent> 複製程式碼
進入父專案,可以看到父專案的父專案(爺專案)
<!-- 爺爺專案(他的父專案)是 --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐dependencies</artifactId> <version>2.2.2.RELEASE</version> <relativePath>../../spring‐boot‐dependencies</relativePath> </parent> 複製程式碼
他來真正管理Spring Boot應用裡面的所有依賴版本;是Spring Boot的版本仲裁中心;
以後我們匯入依賴預設是不需要寫版本的;(沒有在dependencies裡面管理的依賴自然需要宣告版本號)
-
啟動器
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐starter‐web</artifactId> </dependency> 複製程式碼
spring-boot-starter-web:
spring-boot-starter:spring-boot場景啟動器;幫我們匯入了web模組正常執行所依賴的元件;
Spring Boot將所有的功能場景都抽取出來,做成一個個的starters(啟動器),只需要在專案裡面引入這些 starter
相關場景的所有依賴都會匯入進來。要用什麼功能就匯入什麼場景的啟動器
3.4.2、主程式類,主入口類(跟著假裝點進去,看看原始碼,成為一個看過原始碼的初學者)
/**
* @SpringBootApplication 來標註一個主程式類,說明這是一個Spring Boot應用
*/
@SpringBootApplication
public class HelloWorldMainApplication {
public static void main(String[] args) {
// Spring應用啟動起來
SpringApplication.run(HelloWorldMainApplication.class, args);
}
}
複製程式碼
@SpringBootApplication: Spring Boot應用標註在某個類上說明這個類是SpringBoot的主配置類,SpringBoot
就應該執行這個類的main方法來啟動SpringBoot應用;
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
複製程式碼
@SpringBootConfiguration:Spring Boot的配置類; 標註在某個類上,表示這是一個Spring Boot的配置類;
@Configuration:用來標註這是個配置類;
@EnableAutoConfiguration:開啟自動配置功能;
以前我們需要配置的東西,Spring Boot幫我們自動配置;@EnableAutoConfiguration告訴SpringBoot開啟自動配置功能;這樣自動配置才能生效;
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
複製程式碼
@AutoConfigurationPackage:自動配置包
Spring的底層註解**@Import**,給容器中匯入一個元件;匯入的元件由AutoConfigurationImportSelector.class
將主配置類(@SpringBootApplication標註的類)的所在包及下面所有子包裡面的所有元件掃描到Spring容器;
@Import(EnableAutoConfigurationImportSelector.class); 給容器中匯入元件?
AutoConfigurationImportSelector:匯入哪些元件的選擇器;
將所有需要匯入的元件以全類名的方式返回;這些元件就會被新增到容器中;
會給容器中匯入非常多的自動配置類(xxxAutoConfiguration);就是給容器中匯入這個場景需要的所有元件, 並配置好這些元件;
有了自動配置類,免去了我們手動編寫配置注入功能元件等的工作;
SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
複製程式碼
Spring Boot在啟動的時候從類路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值,將這些值作為自動配置類匯入到容器中,自動配置類就生效,幫我們進行自動配置工作;以前我們需要自己配置的東西,自動配置類都幫我們配置好了;
J2EE的整體整合解決方案和自動配置都在spring-boot-autoconfigure-2.2.2.RELEASE.jar;
3.5、使用Spring Initializer快速建立Spring Boot專案
-
IDEA:可以使用 Spring Initializer快速建立專案
IDE都支援使用Spring的專案建立嚮導快速建立一個Spring Boot專案; 選擇我們需要的模組;嚮導會聯網建立Spring Boot專案;
預設生成的Spring Boot專案;
- 主程式已經生成好了,我們只需要我們自己的邏輯
- resources資料夾中目錄結構
- static:儲存所有的靜態資源; js css images;
- templates:儲存所有的模板頁面;(Spring Boot預設jar包使用嵌入式的Tomcat,預設不支援JSP頁面);可以使用模板引擎(freemarker、thymeleaf);
- application.properties:Spring Boot應用的配置檔案;可以修改一些預設設定;
-
STS使用 Spring Starter Project快速建立專案
二、配置檔案
1、配置檔案
SpringBoot使用一個全域性的配置檔案,配置檔名是固定的(有兩種形式);
- application.properties
- application.yml
配置檔案的作用:修改SpringBoot自動配置的預設值;(SpringBoot在底層都給我們自動配置好了)
YAML(YAML Ain't Markup Language) YAML A Markup Language:是一個標記語言
YAML:以資料為中心,比json、xml等更適合做配置檔案;
以前的配置檔案;大多都使用的是 xxxx.xml檔案;eg:
YAML:配置例子
server:
port: 8080
複製程式碼
XML例子:
<server>
<port>8080</port>
</server>
複製程式碼
2、YAML語法:
1、基本語法
k:(空格)v:表示一對鍵值對(空格必須有);
以空格的縮排來控制層級關係;只要是左對齊的一列資料,都是同一個層級的
server:
port: 8080
path: /hello
複製程式碼
屬性和值是大小寫敏感的;
2、值的寫法
字面量:普通的值(數字,字串,布林)
k: v:字面直接來寫;
字串預設不用加上單引號或者雙引號;
""
:雙引號;不會轉義字串裡面的特殊字元;特殊字元會作為本身想表示的意思name: "zhangsan \n lisi":輸出;zhangsan 換行 lisi
''
:單引號;會轉義特殊字元,特殊字元最終只是一個普通的字串資料
name: ‘zhangsan \n lisi’:輸出;zhangsan \n lisi
物件、Map(屬性和值)(鍵值對):
k: v
:在下一行來寫物件的屬性和值的關係;注意縮排
物件還是k: v的方式
friends:
lastName: zhangsan
age: 20
複製程式碼
行內寫法:
friends: {lastName: zhangsan,age: 20}
複製程式碼
陣列(List、Set):
用-
值表示陣列中的一個元素
pets:
‐ cat
‐ dog
‐ pig
複製程式碼
行內寫法
pets: [cat,dog,pig]
複製程式碼
3、配置檔案值注入
3.1、配置檔案:
person:
lastName: hello
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
‐ lisi
‐ zhaoliu
dog:
name: 小狗
age: 12
複製程式碼
3.2、javaBean:
/**
* 將配置檔案中配置的每一個屬性的值,對映到這個元件中
* @ConfigurationProperties:告訴SpringBoot將本類中的所有屬性和配置檔案中相關的配置進行繫結;
* prefix = "person":配置檔案中哪個下面的所有屬性進行一一對映
*
* 只有這個元件是容器中的元件,才能使用容器提供的@ConfigurationProperties功能;
*
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
複製程式碼
我們可以匯入配置檔案處理器,以後編寫配置就有提示了
<!‐‐匯入配置檔案處理器,配置檔案進行繫結就會有提示‐‐>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐configuration‐processor</artifactId>
<optional>true</optional>
</dependency>
複製程式碼
3.3、@Value獲取值和@ConfigurationProperties獲取值的區別
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置檔案中的屬性 | 一個個指定 |
鬆散繫結(鬆散語法) | 支援 | 不支援 |
SpEL | 不支援 | 支援 |
JSR303資料校驗 | 支援 | 不支援 |
複雜型別封裝 | 支援 | 不支援 |
-
配置檔案yml還是properties他們都能獲取到值;
-
如果說,我們只是在某個業務邏輯中需要獲取一下配置檔案中的某項值,使用@Value;
-
如果說,我們專門編寫了一個javaBean來和配置檔案進行對映,我們就直接使用@ConfigurationProperties;
3.4、配置檔案注入值資料校驗
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
/**
* <bean class="Person">
* <property name="lastName" value="字面量/${key}從環境變數、配置檔案中獲取值/#
{SpEL}"></property>
* <bean/>
*/
//lastName必須是郵箱格式
@Email
//@Value("${person.last‐name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
複製程式碼
3.5、@PropertySource&@ImportResource&@Bean
@PropertySource:載入指定的配置檔案;
/**
* 將配置檔案中配置的每一個屬性的值,對映到這個元件中
* @ConfigurationProperties:告訴SpringBoot將本類中的所有屬性和配置檔案中相關的配置進行繫結;
* prefix = "person":配置檔案中哪個下面的所有屬性進行一一對映
*
* 只有這個元件是容器中的元件,才能容器提供的@ConfigurationProperties功能;
* @ConfigurationProperties(prefix = "person")預設從全域性配置檔案中獲取值;
*
*/
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
/**
* <bean class="Person">
* <property name="lastName" value="字面量/${key}從環境變數、配置檔案中獲取值/#
{SpEL}"></property>
* <bean/>
*/
//lastName必須是郵箱格式
// @Email
//@Value("${person.last‐name}")
private String lastName;
//@Value("#{11*2}")
private Integer age;
//@Value("true")
private Boolean boss;}
複製程式碼
@ImportResource:匯入Spring的配置檔案,讓配置檔案裡面的內容生效;
Spring Boot裡面沒有Spring的配置檔案,我們自己編寫的配置檔案,也不能自動識別; 想讓Spring
的配置檔案生效,載入進來;需要將@ImportResource標註在一個配置類上,匯入Spring的配置檔案讓其生效
@ImportResource(locations = {"classpath:beans.xml"})
複製程式碼
自定義的Spring配置檔案
<?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="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>
複製程式碼
SpringBoot推薦給容器中新增元件的方式;推薦使用全註解的方式
-
配置類**@Configuration**------>Spring配置檔案
-
使用**@Bean**給容器中新增元件
/** * @Configuration:指明當前類是一個配置類;就是來替代之前的Spring配置檔案 * 在配置檔案中用<bean><bean/>標籤新增元件 */ @Configuration public class MyAppConfig { //將方法的返回值新增到容器中;容器中這個元件預設的id就是方法名 @Bean public HelloService helloService02(){ System.out.println("配置類@Bean給容器中新增元件了..."); return new HelloService(); } } 複製程式碼
3.6、配置檔案佔位符
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
複製程式碼
3.7、Profile
3.7.1、多Profile檔案
我們在主配置檔案編寫的時候,檔名可以是 application-{profile}.properties/yml
預設使用application.properties的配置;
3.7.2、yml支援多文件塊方式
server:
port: 8081
spring:
profiles:
active: prod
‐‐‐
server:
port: 8083
spring:
profiles: dev
‐‐‐
server:
port: 8084
spring:
profiles: prod #指定屬於哪個環境
複製程式碼
3.7.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
3.8、配置檔案載入位置
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
3.9、外部配置載入順序
SpringBoot也可以從以下位置載入配置; 優先順序從高到低;高優先順序的配置覆蓋低優先順序的配置,所有的配置會形成互補配置
-
命令列引數
所有的配置都可以在命令列上進行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多個配置用空格分開; --配置項=值
-
來 自 java:comp/env 的 JNDI 屬 性
-
Java系統屬性(System.getProperties())
-
作業系統環境變數
-
RandomValuePropertySource配置的random.*屬性值
由jar包外向jar包內進行尋找;優先載入帶profile
- jar包外部的application-{profile}.properties或**application.yml(帶spring.profile)**配置檔案
- jar包內部的application-{profile}.properties或**application.yml(帶spring.profile)**配置檔案
再來載入不帶profile
-
jar包外部的application.properties或application.yml(不帶spring.profile)配置檔案
-
jar包內部的application.properties或**application.yml(不帶spring.profile)**配置檔案
10.@Configuration註解類上的@PropertySource
11.通過SpringApplication.setDefaultProperties指定的預設屬性所有支援的配置載入來源;
3.10、自動配置原理
配置檔案到底能寫什麼?怎麼寫?自動配置原理; 配置檔案能配置的屬性參照
3.10.1、自動配置原理:
1)、SpringBoot啟動的時候載入主配置類,開啟了自動配置功能 @EnableAutoConfiguration
2)、@EnableAutoConfiguration 作用:
-
利用AutoConfigurationImportSelector給容器中匯入一些元件
-
可以檢視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,
\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration
,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration
,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration
複製程式碼
每一個這樣的 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,也是預設生效的;
public class HttpEncodingAutoConfiguration {
//他已經和SpringBoot的配置檔案對映了
private final HttpEncodingProperties properties;
//只有一個有參構造器的情況下,引數的值就會從容器中拿
public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
this.properties = properties;
}
@Bean //給容器中新增一個元件,這個元件的某些值需要從properties中獲取
@ConditionalOnMissingBean(CharacterEncodingFilter.class) //判斷容器沒有這個元件?
public CharacterEncodingFilter characterEncodingFilter() {
CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
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的屬
性進行繫結
public class HttpEncodingProperties {
public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");
複製程式碼
精髓:
1)、SpringBoot啟動會載入大量的自動配置類
2)、我們看我們需要的功能有沒有SpringBoot預設寫好的自動配置類;
3)、我們再來看這個自動配置類中到底配置了哪些元件;(只要我們要用的元件有,我們就不需要再來配置了)
4)、給容器中自動配置類新增元件的時候,會從properties類中獲取某些屬性。我們就可以在配置檔案中指定這 些屬性的值;
xxxxAutoConfigurartion:自動配置類; 給容器中新增元件
xxxxProperties:封裝配置檔案中相關屬性;
3.10.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)
複製程式碼
三、日誌
日誌的詳細介紹和logback的使用點選——>縷清各種Java Logging
1、日誌框架
Java大猿帥在很久很久以前,要開發一個大型系統的心路和發展歷程;
1、System.out.println("");將關鍵資料列印在控制檯;去掉?寫在一個檔案?
2、框架來記錄系統的一些執行時資訊;日誌框架 ; biglogging.jar;
3、高大上的幾個功能?非同步模式?自動歸檔?xxxx? biglogging-good.jar?
4、將以前框架卸下來?換上新的框架,重新修改之前相關的API;biglogging-prefect.jar;
5、JDBC---資料庫驅動;
6、寫了一個統一的介面層;日誌門面(日誌的一個抽象層);logging-abstract.jar; 給專案中匯入具體的日誌實現就行了;我們之前的日誌框架都是實現的抽象層;
市面上的日誌框架;
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....
日誌門面 (日誌的抽象層) | 日誌實現 |
---|---|
JCL(Jakarta Commons Logging)、 SLF4j(Simple Logging Facade for Java)、 jboss-logging | Log4j 、JUL(java.util.logging)、 Log4j2 Logback |
左邊選一個門面(抽象層)、右邊來選一個實現;我蒙著眼隨便選兩個,日誌門面選: SLF4J,日誌實現選:Logback(竟然和SpringBoot的設計者選的一樣,英雄所見略同呀);
SpringBoot:底層是Spring框架,Spring框架預設是用JCL; SpringBoot選用 SLF4j和logback;
2、SLF4j使用
1、如何在系統中使用SLF4j
以後開發的時候,日誌記錄方法的呼叫,不應該來直接呼叫日誌的實現類,而是呼叫日誌抽象層裡面的方法; 給系統裡面匯入slf4j的jar和 logback的實現jar
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}
複製程式碼
每一個日誌的實現框架都有自己的配置檔案。使用slf4j以後,配置檔案還是做成日誌實現框架自己本身的配置文 件;
2、遺留問題
SpringBoot(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx
統一日誌記錄,即使是別的框架和我一起統一使用slf4j進行輸出?
如何讓系統中所有的日誌都統一到slf4j;
1、將系統中其他日誌框架先排除出去;
2、用中間包來替換原有的日誌框架;
3、我們匯入slf4j其他的實現
3、SpringBoot日誌關係
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter</artifactId>
</dependency>
複製程式碼
SpringBoot使用它來做日誌功能;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐logging</artifactId>
</dependency>
複製程式碼
總結:
-
SpringBoot底層也是使用slf4j+logback的方式進行日誌記錄
-
SpringBoot也把其他的日誌都替換成了slf4j;
-
中間替換包
@SuppressWarnings("rawtypes") public abstract class LogFactory { static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j"; static LogFactory logFactory = new SLF4JLogFactory(); 複製程式碼
-
如果我們要引入其他框架?一定要把這個框架的預設日誌依賴移除掉
Spring框架用的是commons-logging;
<dependency> <groupId>org.springframework</groupId> <artifactId>spring‐core</artifactId> <exclusions> <exclusion> <groupId>commons‐logging</groupId> <artifactId>commons‐logging</artifactId> </exclusion> </exclusions> </dependency> 複製程式碼
SpringBoot能自動適配所有的日誌,而且底層使用slf4j+logback的方式記錄日誌,引入其他框架的時候,只需要把這個框架依賴的日誌框架排除掉即可;
4、日誌使用
4.1、預設配置
SpringBoot預設幫我們配置好了日誌;
//記錄器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//System.out.println();
//日誌的級別;
//由低到高 trace<debug<info<warn<error
//可以調整輸出的日誌級別;日誌就只會在這個級別以以後的高階別生效
logger.trace("這是trace日誌...");
logger.debug("這是debug日誌...");
//SpringBoot預設給我們使用的是info級別的,沒有指定級別的就用SpringBoot預設規定的級別;root
級別
logger.info("這是info日誌...");
logger.warn("這是warn日誌...");
logger.error("這是error日誌...");
}
複製程式碼
日誌輸出格式:
%d表示日期時間,
%thread表示執行緒名,
%‐5level:級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元,否則按照句點分割。
%msg:日誌訊息,
%n是換行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n
複製程式碼
SpringBoot修改日誌的預設配置
logging.level.cn.starfish=trace
#logging.path=
# 不指定路徑在當前專案下生成springboot.log日誌
# 可以指定完整的路徑;
#logging.file=G:/springboot.log
# 在當前磁碟的根路徑下建立spring資料夾和裡面的log資料夾;使用 spring.log 作為預設檔案
logging.path=/spring/log
# 在控制檯輸出的日誌的格式
logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
# 指定檔案中日誌輸出的格式
logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %‐5level === %logger{50} ==== %msg%n
複製程式碼
logging.file | logging.path | Example | Description |
---|---|---|---|
(none) | (none) | 只在控制檯輸出 | |
指定檔名 | (none) | my.log | 輸出日誌到my.log檔案 |
(none) | 指定目錄 | /var/log | 輸出到指定目錄的 spring.log 檔案中 |
4.2、指定配置
給類路徑下放上每個日誌框架自己的配置檔案即可;SpringBoot就不使用他預設配置的了
Logging System | Customization |
---|---|
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | logging.properties |
logback.xml:直接就被日誌框架識別了;
logback-spring.xml:日誌框架就不直接載入日誌的配置項,由SpringBoot解析日誌配置,可以使用SpringBoot
的高階Profile功能
<springProfile name="staging">
<!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
可以指定某段配置只在某個環境下生效
</springProfile>
複製程式碼
如:
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!‐‐
日誌輸出格式:
%d表示日期時間,
%thread表示執行緒名,
%‐5level:級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元,否則按照句點分割。
%msg:日誌訊息,
%n是換行符
‐‐>
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
</layout>
</appender>
複製程式碼
如果使用logback.xml作為日誌配置檔案,還要使用profile功能,會有以下錯誤
no applicable action for [springProfile]
複製程式碼
5、切換日誌框架
可以按照slf4j的日誌適配圖,進行相關的切換;
slf4j+log4j的方式;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>logback‐classic</artifactId>
<groupId>ch.qos.logback</groupId>
</exclusion>
<exclusion>
<artifactId>log4j‐over‐slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j‐log4j12</artifactId>
</dependency>
複製程式碼
切換為log4j2
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring‐boot‐starter‐logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐log4j2</artifactId>
</dependency>
複製程式碼
四、Web開發
1、使用SpringBoot
1)、建立SpringBoot應用,選中我們需要的模組;
2)、SpringBoot已經預設將這些場景配置好了,只需要在配置檔案中指定少量配置就可以執行起來
3)、自己編寫業務程式碼;
2、SpringBoot對靜態資源的對映規則;
一層一層的剝開SpringBoot到ResourceProperties,可以看到載入resource的路徑順序,以及屬性的一些操作鏈(SpringBoot1.xx的版本是繼承了ResourceLoaderAware,2.xx和1.xx的變化還挺大餓)。
-
所有 /webjars/** ,都去 classpath:/META-INF/resources/webjars/ 找資源;
webjars:以jar包的方式引入靜態資源;
localhost:8080/webjars/jquery/3.3.1/jquery.js
<!‐‐引入jquery‐webjar‐‐>在訪問的時候只需要寫webjars下面資源的名稱即可
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>3.3.1</version>
</dependency>
複製程式碼
-
"/**" 訪問當前專案的任何資源,都去(靜態資源的資料夾)找對映
複製程式碼
"classpath:/META‐INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/" "/":當前專案的根路徑
localhost:8080/abc === 去靜態資原始檔夾裡面找abc
- 歡迎頁; 靜態資原始檔夾下的所有index.html頁面;被"/**"對映;
localhost:8080/ 找index頁面
- 所有的 **/favicon.ico 都是在靜態資原始檔下找;
## **3**、模板引擎
常見的模板引擎:JSP、Velocity、Freemarker、Thymeleaf
![template.png](http://ww1.sinaimg.cn/large/9b9f09a9ly1ga268zn2bxj20hy08b0t0.jpg)
SpringBoot推薦的Thymeleaf; 語法更簡單,功能更強大;
### 3.1、引入thymeleaf;
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐thymeleaf</artifactId>
</dependency>
<!--切換thymeleaf版本-->
<properties>
<thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
<!‐‐佈局功能的支援程式 thymeleaf3主程式 layout2以上版本‐‐>
<!‐‐ thymeleaf2 layout1‐‐>
<thymeleaf‐layout‐dialect.version>2.2.2</thymeleaf‐layout‐dialect.version>
</properties>
複製程式碼
3.2、Thymeleaf使用
@ConfigurationProperties(prefix = "spring.thymeleaf")
public class ThymeleafProperties {
private static final Charset DEFAULT_ENCODING = Charset.forName("UTF‐8");
private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
public static final String DEFAULT_PREFIX = "classpath:/templates/";
public static final String DEFAULT_SUFFIX = ".html";
複製程式碼
只要我們把HTML頁面放在classpath:/templates/,thymeleaf就能自動渲染;
-
匯入thymeleaf的名稱空間
<html lang="en" xmlns:th="http://www.thymeleaf.org"> 複製程式碼
-
使用thymeleaf語法;
<!DOCTYPE html> <html lang="en" xmlns:th="http://www.thymeleaf.org"> <head> <meta charset="UTF‐8"> <title>Title</title> </head> <body> <h1>成功!</h1> <!‐‐th:text 將div裡面的文字內容設定為 ‐‐> <div th:text="${hello}">這是顯示歡迎資訊</div> </body> </html> 複製程式碼
3.3、語法規則
1)、th:text;改變當前元素裡面的文字內容;
th:任意html屬性;來替換原生屬性的值
2)、表示式
Simple expressions:(表示式語法)
Variable Expressions: ${...}:獲取變數值;OGNL;
1)、獲取物件的屬性、呼叫方法
2)、使用內建的基本物件:
#ctx : the context object.
#vars: the context variables.
#locale : the context locale.
#request : (only in Web Contexts) the HttpServletRequest object.
#response : (only in Web Contexts) the HttpServletResponse object.
#session : (only in Web Contexts) the HttpSession object.
#servletContext : (only in Web Contexts) the ServletContext object.
${session.foo}
3)、內建的一些工具物件:
#execInfo : information about the template being processed.
#messages : methods for obtaining externalized messages inside variables expressions, in the
same way as they would be obtained using #{…} syntax.
#uris : methods for escaping parts of URLs/URIs
#conversions : methods for executing the configured conversion service (if any).
#dates : methods for java.util.Date objects: formatting, component extraction, etc.
#calendars : analogous to #dates , but for java.util.Calendar objects.
#numbers : methods for formatting numeric objects.
#strings : methods for String objects: contains, startsWith, prepending/appending, etc.
#objects : methods for objects in general.
#bools : methods for boolean evaluation.
#arrays : methods for arrays.
#lists : methods for lists.
#sets : methods for sets.
#maps : methods for maps.
#aggregates : methods for creating aggregates on arrays or collections.
#ids : methods for dealing with id attributes that might be repeated (for example, as a
result of an iteration).
Selection Variable Expressions: *{...}:選擇表示式:和${}在功能上是一樣;
補充:配合 th:object="${session.user}:
<div th:object="${session.user}">
<p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
<p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
<p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>
Message Expressions: #{...}:獲取國際化內容
Link URL Expressions: @{...}:定義URL;
@{/order/process(execId=${execId},execType='FAST')}
Fragment Expressions: ~{...}:片段引用表示式
<div th:insert="~{commons :: main}">...</div>
Literals(字面量)
Text literals: 'one text' , 'Another one!' ,…
Number literals: 0 , 34 , 3.0 , 12.3 ,…
Boolean literals: true , false
Null literal: null
Literal tokens: one , sometext , main ,…
Text operations:(文字操作)
String concatenation: +
Literal substitutions: |The name is ${name}|
Arithmetic operations:(數學運算)
Binary operators: + , ‐ , * , / , %
複製程式碼
4、SpringMVC自動配置
4.1、Spring MVC auto-configuration
Spring Boot 自動配置好了SpringMVC
以下是SpringBoot對SpringMVC的預設配置:(WebMvcAutoConfiguration)
- Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
- 自動配置了ViewResolver(檢視解析器:根據方法的返回值得到檢視物件(View),檢視物件決定如何 渲染(轉發?重定向?))
- ContentNegotiatingViewResolver:組合所有的檢視解析器的;
- 如何定製:我們可以自己給容器中新增一個檢視解析器;自動的將其組合進來;
- Support for serving static resources, including support for WebJars (see below).靜態資原始檔夾路 徑,webjars
- Static index.html support. 靜態首頁訪問
- Custom Favicon support (see below). favicon.ico
- 自動註冊了 of Converter , GenericConverter , Formatter beans. Converter:轉換器; public String hello(User user):型別轉換使用Converter Formatter 格式化器; 2017.12.17===Date;
@Bean
@ConditionalOnProperty(prefix = "spring.mvc", name = "date‐format")//在檔案中配置日期格
式化的規則
public Formatter<Date> dateFormatter() {
return new DateFormatter(this.mvcProperties.getDateFormat());//日期格式化元件
}
複製程式碼
自己新增的格式化器轉換器,我們只需要放在容器中即可
- Support for HttpMessageConverters (see below).
- HttpMessageConverter:SpringMVC用來轉換Http請求和響應的;User---Json
- HttpMessageConverters 是從容器中確定;獲取所有的HttpMessageConverter; 自己給容器中新增HttpMessageConverter,只需要將自己的元件註冊容器中 (@Bean,@Component)
- Automatic registration of MessageCodesResolver (see below).定義錯誤程式碼生成規則
- Automatic use of a ConfigurableWebBindingInitializer bean (see below). 我們可以配置一個ConfigurableWebBindingInitializer來替換預設的;(新增到容器)
4.2、擴充套件SpringMVC
<mvc:view‐controller path="/hello" view‐name="success"/>
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/hello"/>
<bean></bean>
</mvc:interceptor>
</mvc:interceptors>
複製程式碼
編寫一個配置類(@Configuration),是WebMvcConfigurerAdapter型別;不能標註@EnableWebMvc;
既保留了所有的自動配置,也能用我們擴充套件的配置;
//使用WebMvcConfigurerAdapter可以來擴充套件SpringMVC的功能
@Configuration
public class MyMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
// super.addViewControllers(registry);
//瀏覽器傳送 /atguigu 請求來到 success
registry.addViewController("/atguigu").setViewName("success");
}
}
複製程式碼
原理:
1)、WebMvcAutoConfiguration是SpringMVC的自動配置類
2)、在做其他自動配置時會匯入;@Import(EnableWebMvcConfiguration.class)
@Configuration
public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration {
private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
//從容器中獲取所有的WebMvcConfigurer
@Autowired(required = false)
public void setConfigurers(List<WebMvcConfigurer> configurers) {
if (!CollectionUtils.isEmpty(configurers)) {
this.configurers.addWebMvcConfigurers(configurers);
//一個參考實現;將所有的WebMvcConfigurer相關配置都來一起呼叫;
@Override
// public void addViewControllers(ViewControllerRegistry registry) {
// for (WebMvcConfigurer delegate : this.delegates) {
// delegate.addViewControllers(registry);
// }
}
}
}
複製程式碼
3)、容器中所有的WebMvcConfigurer都會一起起作用;
4)、我們的配置類也會被呼叫;
效果:SpringMVC的自動配置和我們的擴充套件配置都會起作用;
4.3、全面接管SpringMVC;
SpringBoot對SpringMVC的自動配置不需要了,所有都是我們自己配置;所有的SpringMVC的自動配置都失效了 我們需要在配置類中新增@EnableWebMvc即可;
//使用WebMvcConfigurerAdapter可以來擴充套件SpringMVC的功能
@EnableWebMvc
@Configuration
public class MyMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
// super.addViewControllers(registry);
//瀏覽器傳送 /atguigu 請求來到 success
registry.addViewController("/atguigu").setViewName("success");
}
}
複製程式碼
原理:
為什麼@EnableWebMvc自動配置就失效了;
1)@EnableWebMvc的核心
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
複製程式碼
2)、
@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
複製程式碼
3)、
@Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
WebMvcConfigurerAdapter.class })
//容器中沒有這個元件的時候,這個自動配置類才生效
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {
複製程式碼
4)、@EnableWebMvc將WebMvcConfigurationSupport元件匯入進來;
5)、匯入的WebMvcConfigurationSupport只是SpringMVC最基本的功能;
5、如何修改SpringBoot的預設配置
模式:
1)、SpringBoot在自動配置很多元件的時候,先看容器中有沒有使用者自己配置的(@Bean、@Component)如 果有就用使用者配置的,如果沒有,才自動配置;如果有些元件可以有多個(ViewResolver)將使用者配置的和自己默 認的組合起來;
2)、在SpringBoot中會有非常多的xxxConfigurer幫助我們進行擴充套件配置
3)、在SpringBoot中會有很多的xxxCustomizer幫助我們進行定製配置
6、RestfulCRUD
1)、預設訪問首頁
//使用WebMvcConfigurerAdapter可以來擴充套件SpringMVC的功能
//@EnableWebMvc 不要接管SpringMVC
@Configuration
public class MyMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
// super.addViewControllers(registry);
//瀏覽器傳送 /atguigu 請求來到 success
registry.addViewController("/atguigu").setViewName("success");
}
//所有的WebMvcConfigurerAdapter元件都會一起起作用
@Bean //將元件註冊在容器
public WebMvcConfigurerAdapter webMvcConfigurerAdapter(){
WebMvcConfigurerAdapter adapter = new WebMvcConfigurerAdapter() {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/").setViewName("login");
registry.addViewController("/index.html").setViewName("login");
}
};
return adapter;
}
}
複製程式碼
2)、國際化
- 編寫國際化配置檔案;
- 使用ResourceBundleMessageSource管理國際化資原始檔
- 在頁面使用fmt:message取出國際化內容
步驟:
a、編寫國際化配置檔案,抽取頁面需要顯示的國際化訊息
b、SpringBoot自動配置好了管理國際化資原始檔的元件;
@ConfigurationProperties(prefix = "spring.messages")
public class MessageSourceAutoConfiguration {
/**
* Comma‐separated list of basenames (essentially a fully‐qualified classpath
* location), each following the ResourceBundle convention with relaxed support for
* slash based locations. If it doesn't contain a package qualifier (such as
* "org.mypackage"), it will be resolved from the classpath root.
*/
private String basename = "messages";
//我們的配置檔案可以直接放在類路徑下叫messages.properties;
@Bean
public MessageSource messageSource() {
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
if (StringUtils.hasText(this.basename)) {
//設定國際化資原始檔的基礎名(去掉語言國家程式碼的)
messageSource.setBasenames(StringUtils.commaDelimitedListToStringArray(
StringUtils.trimAllWhitespace(this.basename)));
}
if (this.encoding != null) {
messageSource.setDefaultEncoding(this.encoding.name());
}
messageSource.setFallbackToSystemLocale(this.fallbackToSystemLocale);
messageSource.setCacheSeconds(this.cacheSeconds);
messageSource.setAlwaysUseMessageFormat(this.alwaysUseMessageFormat);
return messageSource;
}
複製程式碼
@ConfigurationProperties(prefix = "spring.messages")
public class MessageSourceAutoConfiguration { 3
private String basename = "messages";
//我們的配置檔案可以直接放在類路徑下叫messages.properties; 12
@Bean
public MessageSource messageSource() {
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
if (StringUtils.hasText(this.basename)) {
//設定國際化資原始檔的基礎名(去掉語言國家程式碼的) messageSource.setBasenames(StringUtils.commaDelimitedListToStringArray(
StringUtils.trimAllWhitespace(this.basename))); 20 }
if (this.encoding != null) {
messageSource.setDefaultEncoding(this.encoding.name()); 23 }
messageSource.setFallbackToSystemLocale(this.fallbackToSystemLocale);
messageSource.setCacheSeconds(this.cacheSeconds);
messageSource.setAlwaysUseMessageFormat(this.alwaysUseMessageFormat);
return messageSource; 28 }
複製程式碼
c、去頁面獲取國際化的值;
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta http‐equiv="Content‐Type" content="text/html; charset=UTF‐8">
<meta name="viewport" content="width=device‐width, initial‐scale=1, shrink‐to‐
fit=no">
<meta name="description" content="">
<meta name="author" content="">
<title>Signin Template for Bootstrap</title>
<!‐‐ Bootstrap core CSS ‐‐>
<link href="asserts/css/bootstrap.min.css"
th:href="@{/webjars/bootstrap/4.0.0/css/bootstrap.css}" rel="stylesheet">
<!‐‐ Custom styles for this template ‐‐>
<link href="asserts/css/signin.css" th:href="@{/asserts/css/signin.css}"
rel="stylesheet">
</head>
<body class="text‐center">
<form class="form‐signin" action="dashboard.html">
<img class="mb‐4" th:src="@{/asserts/img/bootstrap‐solid.svg}"
src="asserts/img/bootstrap‐solid.svg" alt="" width="72" height="72">
<h1 class="h3 mb‐3 font‐weight‐normal" th:text="#{login.tip}">Please sign
in</h1>
<label class="sr‐only" th:text="#{login.username}">Username</label>
<input type="text" class="form‐control" placeholder="Username" th:placeholder="#
{login.username}" required="" autofocus="">
<label class="sr‐only" th:text="#{login.password}">Password</label>
<input type="password" class="form‐control" placeholder="Password"
th:placeholder="#{login.password}" required="">
<div class="checkbox mb‐3">
<label>
<input type="checkbox" value="remember‐me"/> [[#{login.remember}]]
</label>
</div>
<button class="btn btn‐lg btn‐primary btn‐block" type="submit" th:text="#
{login.btn}">Sign in</button>
<p class="mt‐5 mb‐3 text‐muted">© 2017‐2018</p>
<a class="btn btn‐sm">中文</a>
<a class="btn btn‐sm">English</a>
</form>
</body>
</html>
複製程式碼
效果:根據瀏覽器語言設定的資訊切換了國際化;
原理:
國際化Locale(區域資訊物件);LocaleResolver(獲取區域資訊物件);預設的就是根據請求頭帶來的區域資訊獲取Locale進行國際化
@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "spring.mvc", name = "locale")
public LocaleResolver localeResolver() {
if (this.mvcProperties
.getLocaleResolver() == WebMvcProperties.LocaleResolver.FIXED) {
return new FixedLocaleResolver(this.mvcProperties.getLocale());
}
AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver();
localeResolver.setDefaultLocale(this.mvcProperties.getLocale());
return localeResolver;
}
複製程式碼
d、點選連結切換國際化
/**
* 可以在連線上攜帶區域資訊
*/
public class MyLocaleResolver implements LocaleResolver {
@Override
public Locale resolveLocale(HttpServletRequest request) {
String l = request.getParameter("l");
Locale locale = Locale.getDefault();
if(!StringUtils.isEmpty(l)){
String[] split = l.split("_");
locale = new Locale(split[0],split[1]);
}
return locale;
}
@Override
public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale
locale) {
}
}
@Bean
public LocaleResolver localeResolver(){
return new MyLocaleResolver();
}
}
複製程式碼
3)、登陸
開發期間模板引擎頁面修改以後,要實時生效
a、禁用模板引擎的快取
# 禁用快取
spring.thymeleaf.cache=false
複製程式碼
b、頁面修改完成以後ctrl+f9:重新編譯; 登陸錯誤訊息的顯示
<p style="color: red" th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>
複製程式碼
4)、攔截器進行登陸檢查
攔截器
/**
* 登陸檢查,
*/
public class LoginHandlerInterceptor implements HandlerInterceptor {
//目標方法執行之前
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
Object user = request.getSession().getAttribute("loginUser");
if(user == null){
//未登陸,返回登陸頁面
request.setAttribute("msg","沒有許可權請先登陸");
request.getRequestDispatcher("/index.html").forward(request,response);
return false;
}else{
//已登陸,放行請求
return true;
}
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object
handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
}
複製程式碼
註冊攔截器
//所有的WebMvcConfigurerAdapter元件都會一起起作用
@Bean //將元件註冊在容器
public WebMvcConfigurerAdapter webMvcConfigurerAdapter(){
WebMvcConfigurerAdapter adapter = new WebMvcConfigurerAdapter() {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/").setViewName("login");
registry.addViewController("/index.html").setViewName("login");
registry.addViewController("/main.html").setViewName("dashboard");
}
//註冊攔截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
//super.addInterceptors(registry);
//靜態資源; *.css , *.js
//SpringBoot已經做好了靜態資源對映
registry.addInterceptor(new
LoginHandlerInterceptor()).addPathPatterns("/**")
.excludePathPatterns("/index.html","/","/user/login");
}
};
return adapter;
}
複製程式碼
5)、CRUD-員工列表
實驗要求:
a、RestfulCRUD:CRUD滿足Rest風格;
URI: /資源名稱/資源標識 HTTP請求方式區分對資源CRUD操作
普通CRUD(uri來區分操作) | RestfulCRUD | |
---|---|---|
查詢 | getEmp | emp---GET |
新增 | addEmp?xxx | emp---POST |
修改 | updateEmp?id=xxx&xxx=xx | emp/{id}---PUT |
刪除 | deleteEmp?id=1 | emp/{id}---DELETE |
b、實驗的請求架構;
實驗功能 | 請求URI | 請求方式 |
---|---|---|
查詢所有員工 | emps | GET |
查詢某個員工(來到修改頁面) | emp/1 | GET |
來到新增頁面 | emp | GET |
新增員工 | emp | POST |
來到修改頁面(查出員工進行資訊回顯) | emp/1 | GET |
修改員工 | emp | PUT |
刪除員工 | emp/1 | DELETE |
c、員工列表:
thymeleaf公共頁面元素抽取
1、抽取公共片段
<div th:fragment="copy">
© 2011 The Good Thymes Virtual Grocery
</div>
2、引入公共片段
<div th:insert="~{footer :: copy}"></div>
~{templatename::selector}:模板名::選擇器
~{templatename::fragmentname}:模板名::片段名
3、預設效果:
insert的公共片段在div標籤中
如果使用th:insert等屬性進行引入,可以不用寫~{}:
行內寫法可以加上:[[~{}]];[(~{})];
複製程式碼
三種引入公共片段的th屬性:
th:insert:將公共片段整個插入到宣告引入的元素中
th:replace:將宣告引入的元素替換為公共片段
th:include:將被引入的片段的內容包含進這個標籤中
<footer th:fragment="copy">
© 2011 The Good Thymes Virtual Grocery
</footer>
引入方式
<div th:insert="footer :: copy"></div>
引入片段的時候傳入引數:
6)、CRUD-員工新增
新增頁面
<div th:replace="footer :: copy"></div>
<div th:include="footer :: copy"></div>
效果
<div>
<footer>
© 2011 The Good Thymes Virtual Grocery
</footer>
</div>
<footer>
© 2011 The Good Thymes Virtual Grocery
</footer>
<div>
© 2011 The Good Thymes Virtual Grocery
</div>
複製程式碼
7、錯誤處理機制
1)、SpringBoot預設的錯誤處理機制
預設效果:
a、瀏覽器,返回一個預設的錯誤頁面
b、如果是其他客戶端,預設響應一個json資料
原理:
可以參照ErrorMvcAutoConfiguration;錯誤處理的自動配置; 給容器中新增了以下元件
-
DefaultErrorAttributes:幫我們在頁面共享資訊;
@Override public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) { Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>(); errorAttributes.put("timestamp", new Date()); addStatus(errorAttributes, requestAttributes); addErrorDetails(errorAttributes, requestAttributes, includeStackTrace); addPath(errorAttributes, requestAttributes); return errorAttributes; } 複製程式碼
-
BasicErrorController:處理預設/error請求
@Controller @RequestMapping("${server.error.path:${error.path:/error}}") public class BasicErrorController extends AbstractErrorController { @RequestMapping(produces = "text/html")//產生html型別的資料;瀏覽器傳送的請求來到這個方法處理 public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { HttpStatus status = getStatus(request); Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes( request, isIncludeStackTrace(request, MediaType.TEXT_HTML))); response.setStatus(status.value()); //去哪個頁面作為錯誤頁面;包含頁面地址和頁面內容 ModelAndView modelAndView = resolveErrorView(request, response, status, model); return (modelAndView == null ? new ModelAndView("error", model) : modelAndView); } @RequestMapping @ResponseBody //產生json資料,其他客戶端來到這個方法處理; public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) { Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL)); HttpStatus status = getStatus(request); return new ResponseEntity<Map<String, Object>>(body, status); } 複製程式碼
-
ErrorPageCustomizer:
@Value("${error.path:/error}") //系統出現錯誤以後來到error請求進行處理;(web.xml註冊的錯誤頁面規則) private String path = "/error"; 複製程式碼
-
DefaultErrorViewResolver:
@Override public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) { ModelAndView modelAndView = resolve(String.valueOf(status), model); if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) { modelAndView = resolve(SERIES_VIEWS.get(status.series()), model); } return modelAndView; } private ModelAndView resolve(String viewName, Map<String, Object> model) { //預設SpringBoot可以去找到一個頁面? error/404 String errorViewName = "error/" + viewName; //模板引擎可以解析這個頁面地址就用模板引擎解析 TemplateAvailabilityProvider provider = this.templateAvailabilityProviders .getProvider(errorViewName, this.applicationContext); if (provider != null) { //模板引擎可用的情況下返回到errorViewName指定的檢視地址 return new ModelAndView(errorViewName, model); } //模板引擎不可用,就在靜態資原始檔夾下找errorViewName對應的頁面 error/404.html return resolveResource(errorViewName, model); } 複製程式碼
步驟:
一但系統出現4xx或者5xx之類的錯誤;ErrorPageCustomizer就會生效(定製錯誤的響應規則);就會來到/error 請求;就會被BasicErrorController處理;
-
響應頁面;去哪個頁面是由DefaultErrorViewResolver解析得到的;
protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status, Map<String, Object> model) { //所有的ErrorViewResolver得到ModelAndView for (ErrorViewResolver resolver : this.errorViewResolvers) { ModelAndView modelAndView = resolver.resolveErrorView(request, status, model); if (modelAndView != null) { return modelAndView; } } return null; } 複製程式碼
2)、如何定製錯誤響應:
a. 如何定製錯誤的頁面;
-
有模板引擎的情況下;error/狀態碼; 【將錯誤頁面命名為 錯誤狀態碼.html 放在模板引擎資料夾裡面error 資料夾下】,發生此狀態碼的錯誤就會來到對應的頁面;
我們可以使用4xx和5xx作為錯誤頁面的檔名來匹配這種型別的所有錯誤,精確優先(優先尋找精確的狀態 碼.html);
頁面能獲取的資訊:timestamp:
- 時間戳
- status:狀態碼
- error:錯誤提示exception:異常物件
- message:異常訊息
- errors:JSR303資料校驗的錯誤都在這裡
-
沒有模板引擎(模板引擎找不到這個錯誤頁面),靜態資原始檔夾下找;
-
以上都沒有錯誤頁面,就是預設來到SpringBoot預設的錯誤提示頁面;
b. 如何定製錯誤的json資料;
-
自定義異常處理&返回定製json資料;
@ControllerAdvice public class MyExceptionHandler { @ResponseBody @ExceptionHandler(UserNotExistException.class) public Map<String,Object> handleException(Exception e){ Map<String,Object> map = new HashMap<>(); map.put("code","user.notexist"); map.put("message",e.getMessage()); return map; } } //沒有自適應效果... 複製程式碼
-
轉發到/error進行自適應響應效果處理
@ExceptionHandler(UserNotExistException.class) public String handleException(Exception e, HttpServletRequest request){ Map<String,Object> map = new HashMap<>(); //傳入我們自己的錯誤狀態碼 4xx 5xx,否則就不會進入定製錯誤頁面的解析流程 /** * Integer statusCode = (Integer) request .getAttribute("javax.servlet.error.status_code"); */ request.setAttribute("javax.servlet.error.status_code",500); map.put("code","user.notexist"); map.put("message",e.getMessage()); //轉發到/error return "forward:/error"; } 複製程式碼
3)、將我們的定製資料攜帶出去;
出現錯誤以後,會來到/error請求,會被BasicErrorController處理,響應出去可以獲取的資料是由
getErrorAttributes得到的(是AbstractErrorController(ErrorController)規定的方法);
-
完全來編寫一個ErrorController的實現類【或者是編寫AbstractErrorController的子類】,放在容器中;
-
頁面上能用的資料,或者是json返回能用的資料都是通過errorAttributes.getErrorAttributes得到; 容器中DefaultErrorAttributes.getErrorAttributes();預設進行資料處理的;
自定義ErrorAttributes
//給容器中加入我們自己定義的ErrorAttributes @Component public class MyErrorAttributes extends DefaultErrorAttributes { @Override public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) { Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace); map.put("company","atguigu"); return map; } 複製程式碼
最終的效果:響應是自適應的,可以通過定製ErrorAttributes改變需要返回的內容,
8、配置嵌入式Servlet容器
SpringBoot預設使用Tomcat作為嵌入式的Servlet容器;
1)、如何定製和修改Servlet容器的相關配置;
-
修改和server有關的配置(ServerProperties【也是EmbeddedServletContainerCustomizer】);
server.port=8081 server.context‐path=/crud server.tomcat.uri‐encoding=UTF‐8 //通用的Servlet容器設定 server.xxx //Tomcat的設定 server.tomcat.xxx 複製程式碼
-
編寫一個EmbeddedServletContainerCustomizer:嵌入式的Servlet容器的定製器;來修改Servlet容器的配置
@Bean //一定要將這個定製器加入到容器中 public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer(){ return new EmbeddedServletContainerCustomizer() { //定製嵌入式的Servlet容器相關的規則 @Override public void customize(ConfigurableEmbeddedServletContainer container) { container.setPort(8083); } }; } 複製程式碼
2)、註冊Servlet三大元件【Servlet、Filter、Listener】
由於SpringBoot預設是以jar包的方式啟動嵌入式的Servlet容器來啟動SpringBoot的web應用,沒有web.xml文 件。
註冊三大元件用以下方式
ServletRegistrationBean
//註冊三大元件
@Bean
public ServletRegistrationBean myServlet(){
ServletRegistrationBean registrationBean = new ServletRegistrationBean(new
MyServlet(),"/myServlet");
return registrationBean;
}
複製程式碼
FilterRegistrationBean
@Bean
public FilterRegistrationBean myFilter(){
FilterRegistrationBean registrationBean = new FilterRegistrationBean();
registrationBean.setFilter(new MyFilter());
registrationBean.setUrlPatterns(Arrays.asList("/hello","/myServlet"));
return registrationBean;
}
複製程式碼
ServletListenerRegistrationBean
@Bean
public ServletListenerRegistrationBean myListener(){
ServletListenerRegistrationBean<MyListener> registrationBean = new
ServletListenerRegistrationBean<>(new MyListener());
return registrationBean;
}
複製程式碼
SpringBoot幫我們自動配置SpringMVC的時候,自動的註冊SpringMVC的前端控制器;DIspatcherServlet;
DispatcherServletAutoConfiguration中:
@Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnBean(value = DispatcherServlet.class, name =
DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public ServletRegistrationBean dispatcherServletRegistration(
DispatcherServlet dispatcherServlet) {
ServletRegistrationBean registration = new ServletRegistrationBean(
dispatcherServlet, this.serverProperties.getServletMapping());
//預設攔截: / 所有請求;包靜態資源,但是不攔截jsp請求; /*會攔截jsp
//可以通過server.servletPath來修改SpringMVC前端控制器預設攔截的請求路徑
registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
registration.setLoadOnStartup(
this.webMvcProperties.getServlet().getLoadOnStartup());
if (this.multipartConfig != null) {
registration.setMultipartConfig(this.multipartConfig);
}
return registration;
}
複製程式碼
3)、替換為其他嵌入式Servlet容器
預設支援:
Tomcat(預設使用)
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
引入web模組預設就是使用嵌入式的Tomcat作為Servlet容器;
</dependency>
複製程式碼
Jetty
<!‐‐ 引入web模組 ‐‐>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring‐boot‐starter‐tomcat</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<!‐‐引入其他的Servlet容器‐‐>
<dependency>
<artifactId>spring‐boot‐starter‐jetty</artifactId>
<groupId>org.springframework.boot</groupId>
</dependency>
複製程式碼
Undertow
<!‐‐ 引入web模組 ‐‐>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring‐boot‐starter‐tomcat</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<!‐‐引入其他的Servlet容器‐‐>
<dependency>
<artifactId>spring‐boot‐starter‐undertow</artifactId>
<groupId>org.springframework.boot</groupId>
</dependency>
複製程式碼
4)、嵌入式Servlet容器自動配置原理;
EmbeddedServletContainerAutoConfiguration:嵌入式的Servlet容器自動配置?
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@Configuration
@ConditionalOnWebApplication
@Import(BeanPostProcessorsRegistrar.class)
//匯入BeanPostProcessorsRegistrar:Spring註解版;給容器中匯入一些元件
//匯入了EmbeddedServletContainerCustomizerBeanPostProcessor:
//後置處理器:bean初始化前後(建立完物件,還沒賦值賦值)執行初始化工作
public class EmbeddedServletContainerAutoConfiguration {
@Configuration
@ConditionalOnClass({ Servlet.class, Tomcat.class })//判斷當前是否引入了Tomcat依賴;
@ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search =
SearchStrategy.CURRENT)//判斷當前容器沒有使用者自己定義EmbeddedServletContainerFactory:嵌入式的
Servlet容器工廠;作用:建立嵌入式的Servlet容器
public static class EmbeddedTomcat {
@Bean
public TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory()
{
return new TomcatEmbeddedServletContainerFactory();
}
}
/**
* Nested configuration if Jetty is being used.
*/
@Configuration
@ConditionalOnClass({ Servlet.class, Server.class, Loader.class,
WebAppContext.class })
@ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search =
SearchStrategy.CURRENT)
public static class EmbeddedJetty {
@Bean
public JettyEmbeddedServletContainerFactory jettyEmbeddedServletContainerFactory() {
return new JettyEmbeddedServletContainerFactory();
}
}
/**
* Nested configuration if Undertow is being used.
*/
@Configuration
@ConditionalOnClass({ Servlet.class, Undertow.class, SslClientAuthMode.class })
@ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search =
SearchStrategy.CURRENT)
public static class EmbeddedUndertow {
@Bean
public UndertowEmbeddedServletContainerFactory
undertowEmbeddedServletContainerFactory() {
return new UndertowEmbeddedServletContainerFactory();
}
}
複製程式碼
-
EmbeddedServletContainerFactory(嵌入式Servlet容器工廠)
public interface EmbeddedServletContainerFactory { //獲取嵌入式的Servlet容器 EmbeddedServletContainer getEmbeddedServletContainer( ServletContextInitializer... initializers); } 複製程式碼
-
EmbeddedServletContainer:(嵌入式的Servlet容器)
-
以TomcatEmbeddedServletContainerFactory為例
@Override public EmbeddedServletContainer getEmbeddedServletContainer( ServletContextInitializer... initializers) { //建立一個Tomcat Tomcat tomcat = new Tomcat(); //配置Tomcat的基本環節 File baseDir = (this.baseDirectory != null ? this.baseDirectory : createTempDir("tomcat")); tomcat.setBaseDir(baseDir.getAbsolutePath()); Connector connector = new Connector(this.protocol); tomcat.getService().addConnector(connector); customizeConnector(connector); tomcat.setConnector(connector); tomcat.getHost().setAutoDeploy(false); configureEngine(tomcat.getEngine()); for (Connector additionalConnector : this.additionalTomcatConnectors) { tomcat.getService().addConnector(additionalConnector); } prepareContext(tomcat.getHost(), initializers); //將配置好的Tomcat傳入進去,返回一個EmbeddedServletContainer;並且啟動Tomcat伺服器 return getTomcatEmbeddedServletContainer(tomcat); 複製程式碼
我們對嵌入式容器的配置修改是怎麼生效?
ServerProperties、EmbeddedServletContainerCustomizer 複製程式碼
EmbeddedServletContainerCustomizer:定製器幫我們修改了Servlet容器的配置? 怎麼修改的原理?
容器中匯入了EmbeddedServletContainerCustomizerBeanPostProcessor
//初始化之前 @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { //如果當前初始化的是一個ConfigurableEmbeddedServletContainer型別的元件 if (bean instanceof ConfigurableEmbeddedServletContainer) { // postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean); } return bean; } private void postProcessBeforeInitialization( ConfigurableEmbeddedServletContainer bean) { //獲取所有的定製器,呼叫每一個定製器的customize方法來給Servlet容器進行屬性賦值; for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) { customizer.customize(bean); } } private Collection<EmbeddedServletContainerCustomizer> getCustomizers() { if (this.customizers == null) { // Look up does not include the parent context this.customizers = new ArrayList<EmbeddedServletContainerCustomizer>( this.beanFactory //從容器中獲取所有這葛型別的元件:EmbeddedServletContainerCustomizer //定製Servlet容器,給容器中可以新增一個EmbeddedServletContainerCustomizer型別的元件 .getBeansOfType(EmbeddedServletContainerCustomizer.class, false, false) .values()); Collections.sort(this.customizers, AnnotationAwareOrderComparator.INSTANCE); this.customizers = Collections.unmodifiableList(this.customizers); } return this.customizers; } ServerProperties也是定製器 複製程式碼
步驟:
a、SpringBoot根據匯入的依賴情況,給容器中新增相應的
EmbeddedServletContainerFactory【TomcatEmbeddedServletContainerFactory】
b、容器中某個元件要建立物件就會驚動後置處理器; EmbeddedServletContainerCustomizerBeanPostProcessor;
只要是嵌入式的Servlet容器工廠,後置處理器就工作;
c、後置處理器,從容器中獲取所有的EmbeddedServletContainerCustomizer,呼叫定製器的定製方法
5)、嵌入式Servlet容器啟動原理;
什麼時候建立嵌入式的Servlet容器工廠?
什麼時候獲取嵌入式的Servlet容器並啟動Tomcat; 獲取嵌入式的Servlet容器工廠:
-
SpringBoot應用啟動執行run方法
-
refreshContext(context);SpringBoot重新整理IOC容器【建立IOC容器物件,並初始化容器,建立容器中的每一個 組 件 】 ; 如 果 是 web 應 用 創 建 AnnotationConfigEmbeddedWebApplicationContext, 否 則 : AnnotationConfigApplicationContext
-
refresh(context);重新整理剛才建立好的ioc容器;
public void refresh() throws BeansException, IllegalStateException { synchronized (this.startupShutdownMonitor) { // Prepare this context for refreshing. prepareRefresh(); // Tell the subclass to refresh the internal bean factory. ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); // Prepare the bean factory for use in this context. prepareBeanFactory(beanFactory); try { // Allows post‐processing of the bean factory in context subclasses. 複製程式碼
-
onRefresh(); web的ioc容器重寫了onRefresh方法
-
webioc容器會建立嵌入式的Servlet容器;createEmbeddedServletContainer();
-
獲取嵌入式的Servlet容器工廠:
EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory(); 複製程式碼
從ioc容器中獲取EmbeddedServletContainerFactory 元件;TomcatEmbeddedServletContainerFactory建立物件,後置處理器一看是這個物件,就獲取所有的定製器來先定製Servlet容器的相關配置;
-
使用容器工廠獲取嵌入式的Servlet容器:
this.embeddedServletContainer = containerFactory .getEmbeddedServletContainer(getSelfInitializer()); 複製程式碼
-
嵌入式的Servlet容器建立物件並啟動Servlet容器;
先啟動嵌入式的Servlet容器,再將ioc容器中剩下沒有建立出的物件獲取出來;
IOC容器啟動建立嵌入式的Servlet容器
9、使用外接的Servlet容器
9.1. 嵌入式Servlet容器:
應用打成可執行的jar
優點:簡單、便攜;
缺點:預設不支援JSP、優化定製比較複雜(使用定製器【ServerProperties、自定義
EmbeddedServletContainerCustomizer】,自己編寫嵌入式Servlet容器的建立工廠
【EmbeddedServletContainerFactory】);
9.2. 外接的Servlet容器
外面安裝Tomcat---應用war包的方式打包;
步驟
-
必須建立一個war專案;(利用idea建立好目錄結構)
-
將嵌入式的Tomcat指定為provided;
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring‐boot‐starter‐tomcat</artifactId> <scope>provided</scope> </dependency> 複製程式碼
-
必須編寫一個SpringBootServletInitializer的子類,並呼叫configure方法
public class ServletInitializer extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { //傳入SpringBoot應用的主程式 return application.sources(SpringBoot04WebJspApplication.class); } } 複製程式碼
-
啟動伺服器就可以使用;
9.3. 原理
-
jar包:執行SpringBoot主類的main方法——>啟動ioc容器——>建立嵌入式的Servlet容器;
-
war包:啟動伺服器——>伺服器啟動SpringBoot應用【SpringBootServletInitializer】——>啟動ioc容器;
servlet3.0(Spring註解版):
Shared libraries / runtimes pluggability: 規則:
-
伺服器啟動(web應用啟動)會建立當前web應用裡面每一個jar包裡面ServletContainerInitializer例項:
-
ServletContainerInitializer的實現放在jar包的META-INF/services資料夾下,有一個名為
javax.servlet.ServletContainerInitializer的檔案,內容就是ServletContainerInitializer的實現類的全類名
-
還可以使用@HandlesTypes,在應用啟動的時候載入我們感興趣的類;
流程:
-
啟動Tomcat
-
org\springframework\spring-web\4.3.14.RELEASE\spring-web-4.3.14.RELEASE.jar!\META- INF\services\javax.servlet.ServletContainerInitializer:
Spring的web模組裡面有這個檔案:org.springframework.web.SpringServletContainerInitializer
-
SpringServletContainerInitializer將@HandlesTypes(WebApplicationInitializer.class)標註的所有這個型別的類都傳入到onStartup方法的Set>;為這些WebApplicationInitializer型別的類建立例項;
-
每一個WebApplicationInitializer都呼叫自己的onStartup;
-
相當於我們的SpringBootServletInitializer的類會被建立物件,並執行onStartup方法
-
SpringBootServletInitializer例項執行onStartup的時候會createRootApplicationContext;建立容器
protected WebApplicationContext createRootApplicationContext( ServletContext servletContext) { //1、建立SpringApplicationBuilder SpringApplicationBuilder builder = createSpringApplicationBuilder(); StandardServletEnvironment environment = new StandardServletEnvironment(); environment.initPropertySources(servletContext, null); builder.environment(environment); builder.main(getClass()); ApplicationContext parent = getExistingRootWebApplicationContext(servletContext); if (parent != null) { this.logger.info("Root context already created (using as parent)."); servletContext.setAttribute( WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, null); builder.initializers(new ParentContextApplicationContextInitializer(parent)); } builder.initializers( new ServletContextApplicationContextInitializer(servletContext)); builder.contextClass(AnnotationConfigEmbeddedWebApplicationContext.class); //呼叫configure方法,子類重寫了這個方法,將SpringBoot的主程式類傳入了進來 builder = configure(builder); //使用builder建立一個Spring應用 SpringApplication application = builder.build(); if (application.getSources().isEmpty() && AnnotationUtils .findAnnotation(getClass(), Configuration.class) != null) { application.getSources().add(getClass()); } Assert.state(!application.getSources().isEmpty(), "No SpringApplication sources have been defined. Either override the " + "configure method or add an @Configuration annotation"); // Ensure error pages are registered if (this.registerErrorPageFilter) { application.getSources().add(ErrorPageFilterConfiguration.class); } //啟動Spring應用 return run(application); } 複製程式碼
-
Spring的應用就啟動並且建立IOC容器
public ConfigurableApplicationContext run(String... args) { StopWatch stopWatch = new StopWatch(); stopWatch.start(); ConfigurableApplicationContext context = null; FailureAnalyzers analyzers = null; configureHeadlessProperty(); SpringApplicationRunListeners listeners = getRunListeners(args); listeners.starting(); try { ApplicationArguments applicationArguments = new DefaultApplicationArguments( args); ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments); Banner printedBanner = printBanner(environment); context = createApplicationContext(); analyzers = new FailureAnalyzers(context); prepareContext(context, environment, listeners, applicationArguments, printedBanner); //重新整理IOC容器 refreshContext(context); afterRefresh(context, applicationArguments); listeners.finished(context, null); stopWatch.stop(); if (this.logStartupInfo) { new StartupInfoLogger(this.mainApplicationClass) .logStarted(getApplicationLog(), stopWatch); } return context; } catch (Throwable ex) { handleRunFailure(context, listeners, analyzers, ex); throw new IllegalStateException(ex); } } 複製程式碼
啟動Servlet容器,再啟動SpringBoot應用
五、SpringBoot與資料訪問
1、JDBC
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql‐connector‐java</artifactId>
<scope>runtime</scope>
</dependency>
複製程式碼
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://192.168.15.22:3306/jdbc
driver‐class‐name: com.mysql.jdbc.Driver
複製程式碼
預設是用org.apache.tomcat.jdbc.pool.DataSource作為資料來源;
資料來源的相關配置都在DataSourceProperties裡面;
自動配置原理:
org.springframework.boot.autoconfigure.jdbc:
-
參考DataSourceConfiguration,根據配置建立資料來源,預設使用Tomcat連線池;可以使用
spring.datasource.type指定自定義的資料來源型別;
-
SpringBoot預設可以支援;
org.apache.tomcat.jdbc.pool.DataSource、HikariDataSource、BasicDataSource、 複製程式碼
-
自定義資料來源型別
/** * Generic DataSource configuration. */ @ConditionalOnMissingBean(DataSource.class) @ConditionalOnProperty(name = "spring.datasource.type") static class Generic { @Bean public DataSource dataSource(DataSourceProperties properties) { //使用DataSourceBuilder建立資料來源,利用反射建立響應type的資料來源,並且繫結相關屬性 return properties.initializeDataSourceBuilder().build(); } } 複製程式碼
-
DataSourceInitializer:ApplicationListener;
作用:
-
runSchemaScripts();執行建表語句;
-
runDataScripts();執行插入資料的sql語句;
預設只需要將檔案命名為:
schema‐*.sql、data‐*.sql
預設規則:schema.sql,schema‐all.sql;
可以使用
schema:
‐ classpath:department.sql
指定位置
複製程式碼
- 運算元據庫:自動配置了JdbcTemplate運算元據庫
2、整合Druid資料來源
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
複製程式碼
@Configuration
public class DruidConfig {
@ConfigurationProperties(prefix = "spring.datasource")
@Bean
public DataSource druid(){
return new DruidDataSource();
}
//配置Druid的監控
//1、配置一個管理後臺的Servlet
@Bean
public ServletRegistrationBean statViewServlet(){
ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(),
"/druid/*");
Map<String,String> initParams = new HashMap<>();
initParams.put("loginUsername","admin");
initParams.put("loginPassword","123456");
initParams.put("allow","");//預設就是允許所有訪問
initParams.put("deny","192.168.15.21");
bean.setInitParameters(initParams);
return bean;
}
//2、配置一個web監控的filter
@Bean
public FilterRegistrationBean webStatFilter(){
FilterRegistrationBean bean = new FilterRegistrationBean();
bean.setFilter(new WebStatFilter());
Map<String,String> initParams = new HashMap<>();
initParams.put("exclusions","*.js,*.css,/druid/*");
bean.setInitParameters(initParams);
bean.setUrlPatterns(Arrays.asList("/*"));
return bean;
}
}
複製程式碼
3、整合MyBatis
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis‐spring‐boot‐starter</artifactId>
<version>1.3.1</version>
</dependency>
複製程式碼
步驟:
-
配置資料來源相關屬性
-
給資料庫建表
-
建立JavaBean
-
註解版
//指定這是一個運算元據庫的mapper @Mapper public interface DepartmentMapper { @Select("select * from department where id=#{id}") public Department getDeptById(Integer id); @Delete("delete from department where id=#{id}") public int deleteDeptById(Integer id); @Options(useGeneratedKeys = true,keyProperty = "id") @Insert("insert into department(departmentName) values(#{departmentName})") public int insertDept(Department department); @Update("update department set departmentName=#{departmentName} where id=#{id}") public int updateDept(Department department); } 複製程式碼
問題:
自定義MyBatis的配置規則;給容器中新增一個ConfigurationCustomizer;
@org.springframework.context.annotation.Configuration public class MyBatisConfig { @Bean public ConfigurationCustomizer configurationCustomizer(){ return new ConfigurationCustomizer(){ @Override public void customize(Configuration configuration) { configuration.setMapUnderscoreToCamelCase(true); } }; } } 複製程式碼
使用MapperScan批量掃描所有的Mapper介面; @MapperScan(value = "com.atguigu.springboot.mapper") @SpringBootApplication public class SpringBoot06DataMybatisApplication { public static void main(String[] args) { SpringApplication.run(SpringBoot06DataMybatisApplication.class, args); } } 複製程式碼
-
配置檔案版
mybatis: config‐location: classpath:mybatis/mybatis‐config.xml 指定全域性配置檔案的位置 mapper‐locations: classpath:mybatis/mapper/*.xml 指定sql對映檔案的位置 複製程式碼
4、整合SpringData JPA
-
編寫一個實體類(bean)和資料表進行對映,並且配置好對映關係;
//使用JPA註解配置對映關係 @Entity //告訴JPA這是一個實體類(和資料表對映的類) @Table(name = "tbl_user") //@Table來指定和哪個資料表對應;如果省略預設表名就是user; public class User { @Id //這是一個主鍵 @GeneratedValue(strategy = GenerationType.IDENTITY)//自增主鍵 private Integer id; @Column(name = "last_name",length = 50) //這是和資料表對應的一個列 private String lastName; @Column //省略預設列名就是屬性名 private String email; 複製程式碼
-
編寫一個Dao介面來操作實體類對應的資料表(Repository)
//繼承JpaRepository來完成對資料庫的操作 public interface UserRepository extends JpaRepository<User,Integer> { } 複製程式碼
-
基本的配置JpaProperties
spring: jpa: hibernate: # 更新或者建立資料表結構 ddl‐auto: update # 控制檯顯示SQL show‐sql: true 複製程式碼
六、啟動配置原理
幾個重要的事件回撥機制
配置在META-INF/spring.factories
ApplicationContextInitializer
SpringApplicationRunListener
只需要放在ioc容器中ApplicationRunner CommandLineRunner
啟動流程:
1、建立SpringApplication物件
initialize(sources);
private void initialize(Object[] sources) {
//儲存主配置類
if (sources != null && sources.length > 0) {
this.sources.addAll(Arrays.asList(sources));
}
//判斷當前是否一個web應用
this.webEnvironment = deduceWebEnvironment();
//從類路徑下找到META‐INF/spring.factories配置的所有ApplicationContextInitializer;然後儲存起
來
setInitializers((Collection) getSpringFactoriesInstances(
ApplicationContextInitializer.class));
//從類路徑下找到ETA‐INF/spring.factories配置的所有ApplicationListener
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
//從多個配置類中找到有main方法的主配置類
this.mainApplicationClass = deduceMainApplicationClass();
}
複製程式碼
2、執行run方法
public ConfigurableApplicationContext run(String... args) {
StopWatch stopWatch = new StopWatch();
stopWatch.start();
ConfigurableApplicationContext context = null;
FailureAnalyzers analyzers = null;
configureHeadlessProperty();
//獲取SpringApplicationRunListeners;從類路徑下META‐INF/spring.factories
SpringApplicationRunListeners listeners = getRunListeners(args);
//回撥所有的獲取SpringApplicationRunListener.starting()方法
listeners.starting();
try {
//封裝命令列引數
ApplicationArguments applicationArguments = new DefaultApplicationArguments(
args);
//準備環境
ConfigurableEnvironment environment = prepareEnvironment(listeners,
applicationArguments);
//建立環境完成後回撥SpringApplicationRunListener.environmentPrepared();表示環境準
備完成
Banner printedBanner = printBanner(environment);
//建立ApplicationContext;決定建立web的ioc還是普通的ioc
context = createApplicationContext();
analyzers = new FailureAnalyzers(context);
//準備上下文環境;將environment儲存到ioc中;而且applyInitializers();
//applyInitializers():回撥之前儲存的所有的ApplicationContextInitializer的initialize方法
//回撥所有的SpringApplicationRunListener的contextPrepared();
//
prepareContext(context, environment, listeners, applicationArguments,
printedBanner);
//prepareContext執行完成以後回撥所有的SpringApplicationRunListener的contextLoaded();
//s重新整理容器;ioc容器初始化(如果是web應用還會建立嵌入式的Tomcat);Spring註解版
//掃描,建立,載入所有元件的地方;(配置類,元件,自動配置)
refreshContext(context);
//從ioc容器中獲取所有的ApplicationRunner和CommandLineRunner進行回撥
//ApplicationRunner先回撥,CommandLineRunner再回撥
afterRefresh(context, applicationArguments);
//所有的SpringApplicationRunListener回撥finished方法
listeners.finished(context, null);
stopWatch.stop();
if (this.logStartupInfo) {
new StartupInfoLogger(this.mainApplicationClass)
.logStarted(getApplicationLog(), stopWatch);
}
//整個SpringBoot應用啟動完成以後返回啟動的ioc容器;
return context;
}
catch (Throwable ex) {
handleRunFailure(context, listeners, analyzers, ex);
throw new IllegalStateException(ex);
}
}
複製程式碼
3、事件監聽機制
配置在META-INF/spring.factories ApplicationContextInitializer
public class HelloApplicationContextInitializer implements
ApplicationContextInitializer<ConfigurableApplicationContext> {
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
System.out.println("ApplicationContextInitializer...initialize..."+applicationContext);
}
}
複製程式碼
SpringApplicationRunListener
配置(META-INF/spring.factories)
org.springframework.context.ApplicationContextInitializer=\
com.atguigu.springboot.listener.HelloApplicationContextInitializer
org.springframework.boot.SpringApplicationRunListener=\
com.atguigu.springboot.listener.HelloSpringApplicationRunListener
複製程式碼
只需要放在ioc容器中
ApplicationRunner
@Component
public class HelloApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
System.out.println("ApplicationRunner...run....");
}
}
複製程式碼
CommandLineRunner
@Component
public class HelloCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("CommandLineRunner...run..."+ Arrays.asList(args));
}
}
複製程式碼
筆記來源:
《尚矽谷視訊筆記》