Skip to content

Commit

Permalink
Merge pull request #9 from xiaowangzi123/branch_s1
Browse files Browse the repository at this point in the history
Branch s1
  • Loading branch information
xiaowangzi123 authored Jan 27, 2022
2 parents 50a153a + 71d2231 commit c2d5d8f
Show file tree
Hide file tree
Showing 17 changed files with 477 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

@RestController
@SpringBootApplication
public class DemoApplication {
public class Application01 {

@RequestMapping("/")
String index() {
return "hello spring boot";
}

public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
SpringApplication.run(Application01.class, args);
}
}
8 changes: 7 additions & 1 deletion 02.Spring-Boot-Config/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,13 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>


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

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
Expand Down
224 changes: 224 additions & 0 deletions 02.Spring-Boot-Config/readme02.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
## 定制Banner

Spring Boot项目在启动的时候会有一个默认的启动图案:

```
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.3.4.RELEASE)
```

我们可以把这个图案修改为自己想要的。在src/main/resources目录下新建banner.txt文件,然后将自己的图案黏贴进去即可。ASCII图案可通过网站http://www.network-science.de/ascii/一键生成,比如输入mrbird生成图案后复制到banner.txt,启动项目,控制台输出如下:

```
_ _ _ _ _ _
/ \ / \ / \ / \ / \ / \
( s | p | r | i | n | g )
\_/ \_/ \_/ \_/ \_/ \_/
……
2022-01-27 22:20:59.267 INFO 22216 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor'
2022-01-27 22:20:59.386 INFO 22216 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2022-01-27 22:20:59.393 INFO 22216 --- [ main] com.springboot.Application : Started Application in 1.486 seconds (JVM running for 2.941)
```



banner也可以关闭,在main方法中:

```
public static void main(String[] args) {
SpringApplication app = new SpringApplication(DemoApplication.class);
app.setBannerMode(Mode.OFF);
app.run(args);
}
```



## 全局配置文件

在src/main/resources目录下,Spring Boot提供了一个名为application.properties的全局配置文件,可对一些默认配置的配置值进行修改。

> 附:[application.properties中可配置所有官方属性](https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html)
### 自定义属性值

Spring Boot允许我们在application.properties下自定义一些属性,比如:

```
mrbird.blog.name=mrbird's blog
mrbird.blog.title=Spring Boot
```



定义一个BlogProperties Bean,通过`@Value("${属性名}")`来加载配置文件中的属性值:

```
@Component
public class BlogProperties {
@Value("${mrbird.blog.name}")
private String name;
@Value("${mrbird.blog.title}")
private String title;
// get,set略
}
```



编写IndexController,注入该Bean:

```
@RestController
public class IndexController {
@Autowired
private BlogProperties blogProperties;
@RequestMapping("/")
String index() {
return blogProperties.getName()+"——"+blogProperties.getTitle();
}
}
```



启动项目,访问[http://localhost:8080](http://localhost:8080/),页面显示如下:

![QQ截图20171130112735.png](https://mrbird.cc/img/QQ%E6%88%AA%E5%9B%BE20171130112735.png)

在属性非常多的情况下,也可以定义一个和配置文件对应的Bean:

```
@ConfigurationProperties(prefix="mrbird.blog")
public class ConfigBean {
private String name;
private String title;
// get,set略
}
```



通过注解`@ConfigurationProperties(prefix="mrbird.blog")`指明了属性的通用前缀,通用前缀加属性名和配置文件的属性名一一对应。

除此之外还需在Spring Boot入口类加上注解`@EnableConfigurationProperties({ConfigBean.class})`来启用该配置:

```
@SpringBootApplication
@EnableConfigurationProperties({ConfigBean.class})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```



之后便可在IndexController中注入该Bean,并使用了:

```
@RestController
public class IndexController {
@Autowired
private ConfigBean configBean;
@RequestMapping("/")
String index() {
return configBean.getName()+"——"+configBean.getTitle();
}
}
```



### 属性间的引用

在application.properties配置文件中,各个属性可以相互引用,如下:

```
mrbird.blog.name=mrbird's blog
mrbird.blog.title=Spring Boot
mrbird.blog.wholeTitle=${mrbird.blog.name}--${mrbird.blog.title}
```



## 自定义配置文件

除了可以在application.properties里配置属性,我们还可以自定义一个配置文件。在src/main/resources目录下新建一个test.properties:

```
test.name=KangKang
test.age=25
```



定义一个对应该配置文件的Bean:

```
@Configuration
@ConfigurationProperties(prefix="test")
@PropertySource("classpath:test.properties")
@Component
public class TestConfigBean {
private String name;
private int age;
// get,set略
}
```



注解`@PropertySource("classpath:test.properties")`指明了使用哪个配置文件。要使用该配置Bean,同样也需要在入口类里使用注解`@EnableConfigurationProperties({TestConfigBean.class})`来启用该配置。

## 通过命令行设置属性值

在运行Spring Boot jar文件时,可以使用命令`java -jar xxx.jar --server.port=8081`来改变端口的值。这条命令等价于我们手动到application.properties中修改(如果没有这条属性的话就添加)server.port属性的值为8081。

如果不想项目的配置被命令行修改,可以在入口文件的main方法中进行如下设置:

```
public static void main(String[] args) {
SpringApplication app = new SpringApplication(Application.class);
app.setAddCommandLineProperties(false);
app.run(args);
}
```



## 使用xml配置

虽然Spring Boot并不推荐我们继续使用xml配置,但如果出现不得不使用xml配置的情况,Spring Boot允许我们在入口类里通过注解`@ImportResource({"classpath:some-application.xml"})`来引入xml配置文件。

## Profile配置

Profile用来针对不同的环境下使用不同的配置文件,多环境配置文件必须以`application-{profile}.properties`的格式命,其中`{profile}`为环境标识。比如定义两个配置文件:

- application-dev.properties:开发环境

```
server.port=8080
```

- application-prod.properties:生产环境

```
server.port=8081
```

至于哪个具体的配置文件会被加载,需要在application.properties文件中通过`spring.profiles.active`属性来设置,其值对应`{profile}`值。

如:`spring.profiles.active=dev`就会加载application-dev.properties配置文件内容。可以在运行jar文件的时候使用命令`java -jar xxx.jar --spring.profiles.active={profile}`切换不同的环境配置。
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
package com.springboot;

import com.springboot.bean.PropertySourceGet;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

import com.springboot.bean.ConfigBean;
import com.springboot.bean.TestConfigBean;

@SpringBootApplication
@EnableConfigurationProperties({ConfigBean.class,TestConfigBean.class})
//@ImportResource({"classpath:some-application.xml"})
public class Application {
@EnableConfigurationProperties({ConfigBean.class})
//@EnableConfigurationProperties({ConfigBean.class, PropertySourceGet.class})
public class Application02 {
public static void main(String[] args) {
SpringApplication app = new SpringApplication(Application.class);
SpringApplication app = new SpringApplication(Application02.class);
app.setAddCommandLineProperties(false);
// app.setBannerMode(Banner.Mode.OFF);
app.run(args);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
* @author: wyq
* @create time: 2022/1/27
* @description:
* ProfileProperties类没有加@Component注解。
* 在要使用ProfileProperties的地方使用@EnableConfigurationProperties注册我们的配置 bean:
*/
@ConfigurationProperties(prefix="mrbird.blog")
public class ConfigBean {
private String name;
Expand All @@ -24,6 +31,14 @@ public String getWholeTitle() {
}
public void setWholeTitle(String wholeTitle) {
this.wholeTitle = wholeTitle;
}

}

@Override
public String toString() {
return "ConfigBean{" +
"name='" + name + '\'' +
", title='" + title + '\'' +
", wholeTitle='" + wholeTitle + '\'' +
'}';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package com.springboot.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
* @author: wyq
* @create time: 2022/1/27
* @description:
* 通过@ConfigurationProperties读取配置信息并与bean绑定。
*/
@Component
@ConfigurationProperties(prefix="my.config.get")
public class ConfigBean2 {
private String name;
private String title;
private String wholeTitle;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getWholeTitle() {
return wholeTitle;
}
public void setWholeTitle(String wholeTitle) {
this.wholeTitle = wholeTitle;
}

@Override
public String toString() {
return "ConfigBean{" +
"name='" + name + '\'' +
", title='" + title + '\'' +
", wholeTitle='" + wholeTitle + '\'' +
'}';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package com.springboot.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
* @author: wyq
* @create time: 2022/1/27
* @description: @PropertySource读取指定 properties文件
* @PropertySource不支持加载yml配置文件,所以需要自定义一个配置类
*/
@ConfigurationProperties(prefix = "test")
@PropertySource("classpath:property.properties")
//@PropertySource("classpath:property.yml") //此时获取name和age分别为null,0
@Component
public class PropertySourceGet {
private String name;
private int age;

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public int getAge() {
return age;
}

public void setAge(int age) {
this.age = age;
}

}
Loading

0 comments on commit c2d5d8f

Please sign in to comment.