springboot的核心配置文件可以读取哪些配置 springboot核心包

转载

mob64ca13f9a97c 2024-04-12 12:59:18

文章标签 springboot spring xml 配置文件 文章分类 架构后端开发

Spring Boot的基本配置：

一. 配置不继承SpringBoot父依赖项目

在真实的企业级项目中，一个大的项目会由多个子模块组成，每个模块是一个小的项目，那么每个模块都有自己的父项目，这个时候就不能再依赖spring提供的父项目了，这时候怎么办呢?spring boot已经考虑到了这种可能性，下面就来看看怎么解决的。
单一模块的时候，我们会看到我们的Spring Boot项目有个parent依赖，如下所示：

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.5.RELEASE</version>
        <relativePath />
    </parent>

在真实的企业级项目中，这部分内容被我们自己的父模块占用了，比如变成了如下：

<parent>
        <groupId>org.light4j</groupId>
        <artifactId>springBoot-basic</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

这个时候，只需要加如下依赖即可解决原来依赖Spring Boot的parent的问题：

<dependencyManagement>
        <dependencies>
            <dependency>
                <!-- Import dependency management from Spring Boot -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>1.4.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

别的部分不需要变动，后面的内容都按照这种方式来进行。

二. 入口类和@SpringBootApplication

Spring Boot通常有一个名为*Application的入口类，入口类里面有一个main方法，这个main方法其实就是一个标准的Java应用的入口。在main方法中使用SpringApplication.run(HelloApplication.class, args)，启动Spring Boot应用项目。

@SpringBootApplication是Spring Boot的核心注解，它是一个组合注解,对组合注解不了解的朋友可以看前面的文章Spring4.x高级话题(五):组合注解与元注解，SpringBootApplication源码如下：

@Target({java.lang.annotation.ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Configuration
@EnableAutoConfiguration
@ComponentScan
public @interface SpringBootApplication
{
  public abstract Class<?>[] exclude();

  public abstract String[] excludeName();
}

@SpringBootApplication注解主要组合了@Configuration，@EnableAutoConfiguration，@ComponentScan；若不使用@SpringBootApplication注解，则可以在入口类上直接使用@Configuration，@EnableAutoConfiguration，@ComponentScan三个注解的效果是一样的。
其中@EnableAutoConfiguration让Spring Boot根据类路径中的jar包依赖为当前项目进行自动配置。

例如，添加了spring-boot-starter-web依赖，会自动添加Tomcat和Spring MVC的依赖，那么Spring Boot会对Tomcat和Spring MVC进行自动配置。

又如，添加了spring-boot-starter-jpa依赖,Spring Boot会自动进行JPA相关的配置。

Spring Boot会自动扫描@SpringBootApplication所在类的同级包(如org.light4j.springboot.config)以及下级包里面的Bean(若为JPA项目还可以扫描标注@Entity的实体类)。建议入口类放置在groupId+arctifactID组合的包名下。

三. 关闭特定的自动配置

通过上面的@SpringBootApplication的源码可以看出，关闭特定的自动配置应该使用@SpringBootApplication注解的exclude参数，比如要关闭Spring Boot对数据源的自动配置，则可以这样使用，例如：

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class})

四. 定制Banner

1. 修改Banner

在Spring Boot启动的时候会有一个默认启动方案，如下图所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_配置文件

如果想把这个图案修改成自己的，步骤如下所示：

(1). 在src/main/resources下新建一个banner.txt。
(2). 通过http://patorjk.com/software/taag网站生成字符，如敲入的为"fffff",将网站生成的字符复制到banner.txt中。
(3). 这时再启动程序，图案将变为如下图所示：

五. 关闭banner

1. 入口类`main`方法里的内容修改为：

SpringApplication application = new SpringApplication(HelloApplication.class);
application.setBannerMode(Banner.Mode.OFF);
application.run(args);

2. 或者使用`fluent API`修改为：

new SpringApplicationBuilder(HelloApplication.class).bannerMode(Banner.Mode.OFF).run(args);

Spring Boot的配置文件

Spring Boot的全局配置文件的作用是对一些默认配置的配置值进行修改。Spring Boot使用一个全局的配置文件application.properties或application.yml进行全局配置，放置在src/main/resources目录或者类路径的/config下。

Spring Boot不仅支持常规的properties配置文件，还支持yaml语言的配置文件。yaml是以数据为中心的语言，在配置数据的时候具有面向对象的特征。

二. 简单示例

将Tomcat的默认端口号修改为9090，并将默认的访问路径”/”修改为”/springboot_configFile“，可以在application.properties中添加：

server.port=9090
server.context-path=/springboot_configFile

或者在application.yml中添加：

server:
  port:9090
  contextPath:/springboot_configFile

从上面的配置可以看出，在Spring Boot中，context-path,contextPath或者CONTEXT_PATH形式其实是相通的。并且，yaml的配置更简洁清晰，更多Spring Boot常用配置请参考官网文档。

Spring Boot的starter pom

Spring Boot通过使用starter pom使得我们不需要关注各种依赖库的处理，不需要具体的配置信息，由SpringBoot自动通过classpath路径下的类发现需要的Bean，并织入bean。

Spring Boot为我们提供了简化企业级开发绝大多数场景的starter pom，只要使用了应用场景所需要的starter pom，相关的技术配置将会消除，就可以得到Spring Boot为我们提供的自动配置的Bean。

官方提供的starter pom特别多，详细可参考官网文档。下面列出部分供参考：

名称	描述
spring-boot-starter	Spring Boot核心的starter，包含自动配置，日志，yaml配置文件等的支持
spring-boot-starter-actuator	准生产应用，用来监控和管理应用
spring-boot-starter-remote-shell	提供基于ssh协议的监控和管理
spring-boot-starter-amqp	使用spring-rabbit来支持AMQP
spring-boot-starter-aop	使用spring-aop和AspectJ支持面向切面编程
spring-boot-starter-batch	提供对Spring Batch的支持
spring-boot-starter-cache	提供对Spring Cache的支持
spring-boot-starter-cloud-connectors	对云平台(Cloud Foundry，Heroku)提供的服务提供简化的连接方式
spring-boot-starter-data-elasticsearch	通过spring-data-elasticsearch对Elasticsearcht提供支持
spring-boot-starter-data-gemfire	通过spring-data-gemfire对GemFire提供支持
spring-boot-starter-data-jpa	对JPA的支持，包含spring-data-jpa，spring-orm和Hibernate
spring-boot-starter-data-mongodb	通过spring-data-mongodb对MongoDB提供支持
spring-boot-starter-data-rest	通过spring-data-rest-webmvc将Spring Data respository暴露为Rest的服务
spring-boot-starter-data-solr	通过spring-data-rest-solr对Apache Solr数据检索平台的支持。
spring-boot-starter-freemarker	对FreeMarker模板引擎提供支持
spring-boot-starter-groovy-templates	对Groovy模板引擎提供支持
spring-boot-starter-hateoas	通过spring-hateoas对基于HATEOAS的REST形式的网络服务的支持
spring-boot-starter-hornetq	通过Hornetq对JMS的支持
spring-boot-starter-integration	对系统集成框架spring-integration的支持
spring-boot-starter-jdbc	对JDBC数据库的支持
spring-boot-starter-jersey	对Jersery REST形式的网络服务的支持
spring-boot-starter-jta-atomikos	通过Atomikos对分布式事务的支持
spring-boot-starter-jta-bitronix	通过Bitronix对分布式事务的支持
spring-boot-starter-mail	对javax.mail的支持
spring-boot-starter-mobile	对spring-mobile的支持
spring-boot-starter-mustache	对Mustache模板引擎的支持
spring-boot-starter-redis	对键值对内存数据库Redis的支持，包含spring-redis
spring-boot-starter-security	对spring-security的支持
spring-boot-starter-social-facebook	通过spring-social-facebook对FaceBook的支持
spring-boot-starter-social-linkedin	通过spring-social-linkedin对LinkedIn的支持
spring-boot-starter-social-twitter	通过spring-social-twitter对Twitter的支持
spring-boot-starter-test	对常用的测试框架Junit，Hamcrest和Mockito的支持，包含spring-test模块
spring-boot-starter-thymeleaf	对Thymeleaf模板引擎的支持，包含于Spring整合的配置
spring-boot-starter-velocity	对Velocity模板引擎的支持
spring-boot-starter-web	对Web项目开发的支持，包含Tomcat和spring-webmvc
spring-boot-starter-Tomcat	Spring Boot默认的Servlet容器Tomcat
spring-boot-starter-Jetty	使用Jetty作为Servlet容器替换Tomcat
spring-boot-starter-undertow	使用Undertow作为Servlet容器替换Tomcat
spring-boot-starter-logging	Spring Boot默认的日志框架Logback
spring-boot-starter-log4j	支持使用log4J日志框架
spring-boot-starter-websocket	对WebSocket开发的支持
spring-boot-starter-ws	对Spring Web Services的支持

二. 第三方starter pom

除了官方starter pom外，还有第三方为Spring Boot所写的starter pom，如下图所示：

名称	地址
Handlebars	https://github.com/allegro/handlebars-spring-boot-starter
Vaadin	https://github.com/vaadin/spring/tree/master/vaadin-spring-boot-starter
Apache Camel	https://github.com/apache/camel/tree/master/components/camel-spring-boot
WRO4J	https://github.com/sbuettner/spring-boot-autoconfigure-wro4j
Spring Batch(高级用法)	https://github.com/codecentric/spring-boot-starter-batch-web
HDIV	https://github.com/hdiv/spring-boot-starter-hdiv
Jade Templates (Jadw4j)	https://github.com/domix/spring-boot-starter-jade4j
Activiti	https://github.com/Activiti/Activiti/tree/master/modules/activiti-spring-boot/spring-boot-starte

如果有需要我们也可以编写自己的starter pom。

Spring Boot的xml配置

Spring Boot提倡零配置，即无xml配置，但是在实际项目中，可能有一些特殊要求你必须使用xml配置，这时候可以通过在配置类上面使用Spring提供的@ImportResource来在加载xml配置，例如：

@ImportResource(value = { "classpath:some-context.xml","classpath:another-context.xml" })

二. 示例

1. 新建包

新建两个包:org.light4j.springboot.xml.scan和org.light4j.springboot.xml.noScan

2. 新建启动类

新建Application.java启动类，放到包org.light4j.springboot.xml.scan下，根据Spring Boot的扫描原则（扫描从根包到子包的原则），能够扫描到org.light4j.springboot.xml.scan以及它的子包，org.light4j.springboot.xml.noScan包以及子包则不能被扫描到，代码如下：

package org.light4j.springboot.xml.scan;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

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

3. 新建Service类

新建ScanService和NoScanService两个Service类，根据Spring Boot的扫描原则，我们把ScanService写在Spring Boot可以扫描的位置,也即放到包org.light4j.springboot.xml.scan下，NoScanService写在SpringBoot无法扫描到的位置,也即放到包org.light4j.springboot.xml.noScan下。
ScanService.java代码如下所示：

package org.light4j.springboot.xml.scan;

import org.springframework.stereotype.Service;

@Service
public class ScanService {
    public ScanService() {
        System.out.println("I am ScanService,i can be scan");
    }
}

NoScanService.java代码如下所示：

package org.light4j.springboot.xml.noScan;

import org.springframework.stereotype.Service;

@Service
public class NoScanService {
    public NoScanService() {
        System.out.println("I am NoScanService,i can not be scan");
    }
}

4. 运行程序

运行Application.java，看到控制台打印日志如下图所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_配置文件_02

从上面可以看到，在程序启动的时候，执行了ScanService类的构造函数，而NoScanService没有执行，这是因为NoScanService所在的包没有被扫描到，所以没有进行初始化。那么下面我们使用xml配置文件的方式进行引入。

5. 编写application-bean.xml

在src/main/resouces目录下编写配置文件application-bean.xml文件，内容如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- 注入spring boot无法扫描到的bean. -->
    <bean id="noScanService" class="org.light4j.springboot.xml.noScan.NoScanService"></bean>

</beans>

6. 导入配置文件

在启动类Application上使用注解@ImportResource(value = { "classpath:application-bean.xml" })导入bean的配置文件，修改后的Application启动类如下图所示：

package org.light4j.springboot.xml.scan;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication
@ImportResource(value = { "classpath:application-bean.xml" })
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

7.运行程序测试

运行Application.java，现在看到控制台打印日志如下图所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_spring_03

从上面可以看到，在程序启动的时候，ScanService和NoScanService的构造函数都被执行了，二者构造函数里的代码都在控制台打印。

命令行参数配置

Spring Boot可以允许使用properties文件，yaml文件或者命令行参数作为外部配置。使用properties文件，yaml文件进行配置的例子在之前文章Spring Boot核心(二):Spring Boot的配置文件中已经有过演示，下面专门说命令行参数配置。

Spring Boot可以是基于jar包运行的，使用如下命令打包：

mvn package

打成jar包的程序可以直接通过下面的命令运行：

java -jar xxx.jar

可以通过以下命令修改Tomcat端口号：

java -jar xxx.jar --server.port=9090

修改之后Tomcat将在9090端口启动服务。

常规属性配置

在之前的文章Spring4.x常用配置(二):Spring EL和资源调用中讲述了在常规Spring环境下，注入properties文件里面的值的方式，通过@PropertySource指明properties文件的位置，然后通过@Value注入值。在Spring Boot里，我们只需在application.properties定义属性，直接使用@Value注入值即可。

二. 示例

1. application.properties增加属性：

article.author=feeerss
article.name=spring boot

2. 修改控制器类

控制器类如下所示：

package org.light4j.springboot.properties.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @Value("${article.author}")
    private String articleAuthor;
    @Value("${article.name}")
    private String articleName;

    @RequestMapping("/")
    public String hello() {
        return "article name is:" + articleName + " and article author is:" + articleName;
    }
}

3. 运行

启动入口类Application，访问http://localhost:8080/，效果如下图所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_配置文件_04

类型安全的属性配置

常规属性配置文章中使用@Value注入每个配置在实际项目中会显得格外麻烦，因为我们的配置通常会是许多个，若使用上篇文章的方式则要使用@Value注入很多次。

Spring Boot还提供了基于类型安全的属性配置方式，通过@ConfigurationProperties将properties属性和一个Bean及其属性关联，从而实现类型安全的配置。

二. 示例

1. 新建Spring Boot项目

2.添加配置

在application.properties上添加：

article.author=xxxxxxx
article.name=spring boot

当然，我们也可以新建一个properties文件，这就需要我们在@ConfigurationProperties的属性locations里指定properties的位置，且需要在入口类上配置。

3. 创建类型安全的Bean，代码如下所示：

package org.light4j.springboot.save.properties.config;

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

@Component
@ConfigurationProperties(prefix = "article") // ①
public class ArticleSettings {
    private String author;
    private String name;
    public String getAuthor() {
        return author;
    }
    public void setAuthor(String author) {
        this.author = author;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

代码解释：

① 通过ConfigurationProperties加载properties文件内的配置，通过prefix属性指定properties的配置的前缀，通过locations指定properties文件的位置，例如：

@ConfigurationProperties(prefix = "article",locations={"classpath:config/article.properties"})

本例中，由于直接配置在application.properties文件里面，所以不需要配置locations属性。

4. 校验代码，修改HelloController的代码如下所示：

package org.light4j.springboot.save.properties.controller;

import org.light4j.springboot.save.properties.config.ArticleSettings;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Autowired
    private ArticleSettings articleSettings; //①

    @RequestMapping("/")
    public String hello() {
        return "article name is "+ articleSettings.getName()+" and article author is "+articleSettings.getAuthor();
    }
}

代码解释：

① 可以用@Autowired直接注入该配置

日志配置

Spring Boot支持Java Util Logging，Log4J,Log4J2和Logback作为日志框架，无论使用哪种日志框架，SpringBoot已经为当前使用的日志框架在控制台的输出以及在文件的输出做好了配置，可以对比前面文章SpringMvc4.x基础(一):Spring MVC项目快速搭建中没有使用Spring Boot时候的日志配置的方式。

默认情况下，Spring Boot使用Logback作为日志框架。

二. 示例

1. 配置日志文件，格式为logging.file=文件路径：

logging.file=F:/mylog/log.log

2. 配置日志级别，格式为logging.level.包名=级别，如下所示：

logging.level.org.springframework.web = DEBUG

三. 测试

运行程序，可以看到控制台输出DBUG日志如下：

springboot的核心配置文件可以读取哪些配置 springboot核心包_配置文件_05

在文件路径下生成了日志文件,并且里面也保存了日志内容，如下图所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_xml_06

Profile配置

Profile是Spring用来针对不同的环境对不同的配置提供支持的，全局Profile配置使用application-{profile}.properties(如application-prod.properties)。

通过在application.properties中设置spring.profiles.active的值来指定活动的Profile配置。

二. 示例

下面将进行一个最简单的演示，例如我们分别为生产(prod)和开发(dev)环境，生产环境下端口号为80，开发环境下端口号为8888

1. 新建配置文件
在src/main/resources下新建三个配置文件代表普通配置文件，开发环境配置文件，生产环境配置环境，文件名分别是application.properties，application-dev.properties，application-prod.properties。

application-prod.properties文件的内容如下所示：

server.port=80

application-dev.properties文件的内容如下所示：

server.port=8888

此时src/main/resources的目录结构如下所示：

springboot的核心配置文件可以读取哪些配置 springboot核心包_配置文件_07

2. 运行

application.properties增加内容：spring.profiles.active=dev，启动程序结果为：

springboot的核心配置文件可以读取哪些配置 springboot核心包_spring_08

将文件application.properties的内容spring.profiles.active=dev修改为：spring.profiles.active=prod，启动程序结果为：

springboot的核心配置文件可以读取哪些配置 springboot核心包_spring_09

关闭特定的自动配置：

如：@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })

启动查看自动配置报告

在application.properties 增加debug=true

Spring Boot的AOP配置

AOP是Spring框架中的一个重要内容，在Spring boot里配置aop非常简单，Spring Boot对AOP的默认配置属性是开启的，也就是说spring.aop.auto属性的值默认是true，我们只要引入了AOP依赖后，默认就已经增加了@EnableAspectJAutoProxy功能，不需要我们在程序启动类上面加入注解@EnableAspectJAutoProxy。

下面将使用Spring Boot通过模拟记录操作日志来演示基于注解拦截的AOP实现方式。

二. 示例

1. 添加依赖

<!-- aop -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>

2. 编写拦截规则的注解

package org.light4j.springboot.aop.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Action {

    String value() default "";
}

(3). 在控制器的方法上使用注解@Action

package org.light4j.springboot.aop.controller;

import org.light4j.springboot.aop.annotation.Action;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping("/")
    @Action("hello")
    public String hello() {
        return "Hello Spring Boot";
    }
}

代码解释

@Action注解加在方法hello()上面。

(5). 编写切面

package org.light4j.springboot.aop.aspect;

import java.lang.reflect.Method;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.light4j.springboot.aop.annotation.Action;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LogAspect {

    // pointCut
    @Pointcut("@annotation(org.light4j.springboot.aop.annotation.Action)")
    public void log() {

    }

    /**
     * 前置通知
     */
    @Before("log()")
    public void doBeforeController(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        Action action = method.getAnnotation(Action.class);
        System.out.println("action名称 " + action.value()); // ⑤
    }

    /**
     * 后置通知
     */
    @AfterReturning(pointcut = "log()", returning = "retValue")
    public void doAfterController(JoinPoint joinPoint, Object retValue) {
        System.out.println("retValue is:" + retValue);
    }
}

代码解释

①通过@Aspect注解声明该类是一个切面。
②通过@Component让此切面成为Spring容器管理的Bean。
③通过@Pointcut注解声明切面。
④通过@After注解声明一个建言，并使用@Pointcut定义的切点。
⑤通过反射可以获得注解上面的属性，然后做日志记录相关的操作，下面的相同。
⑥通过@Before注解声明一个建言，此建言直接使用拦截规则作为参数。

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：java_opencv 答题卡 java 答题系统

下一篇：resources下配置文件 resources 1

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯