Spring Boot入门

本文介绍SpringBoot框架的快速入门指南,包括环境搭建、项目结构、配置文件使用及日志系统配置。SpringBoot简化了Spring应用的开发流程,提供自动配置和外部配置加载机制,特别强调了日志系统的配置,包括SLF4J和logback的使用,以及如何通过配置文件调整日志级别和格式。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Spring Boot入门

简介

简化Spring应用开发,约定大于配置。整合了整个Spring技术栈。
优点:

  1. 快速创建独立的Spring项目以及与主流框架集成
  2. 使用嵌入式Servlet容器,应用无须打成WAR包
  3. starters自动依赖和版本控制
  4. 大量自动配置,简化开发,可以修改默认值
  5. 无需配置XML,无代码生成,开箱即用
  6. 准生成环境的运行时监控
  7. 与云计算天然集成

微服务

每一个功能元素都是一个可独立替换和独立升级的软件单元。每一个应用之间通过HTTP方式进行互通。

入门程序HelloWorld

  1. 导入spring-boot依赖
<parent>
  	<groupId>org.springframework.boot</groupId>
  	<artifactId>spring-boot-starter-parent</artifactId>
  	<version>1.5.9.RELEASE</version>
  </parent>
  <dependencies>
  	<dependency>
  		<groupId>org.springframework.boot</groupId>
  		<artifactId>spring-boot-starter-web</artifactId>
  	</dependency>
  </dependencies>
  1. 主程序启动Spring Boot应用
package com.shyb.controller;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * @SpringBootApplication 标注一个主程序类,说明这是一个Spirng Boot应用
 */
@SpringBootApplication
public class SpringBootHelloApplication {

	public static void main(String[] args) {
		//Spring应用启动
		SpringApplication.run(SpringBootHelloApplication.class, args);
	}

}

  1. 编写响应的Controller和Service
/**
 * @SpringBootApplication 标注一个主程序类,说明这是一个Spirng Boot应用
 */
@SpringBootApplication
public class SpringBootHelloApplication {

	public static void main(String[] args) {
		//Spring应用启动
		SpringApplication.run(SpringBootHelloApplication.class, args);
	}
}
  1. 目录结构
    在这里插入图片描述
  2. 启动主程序
  3. 访问结果
    在这里插入图片描述

导出与部署

  1. 添加依赖
<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
  1. maven-install,会在target下生成jar包
    在这里插入图片描述
  2. cmd进入命令找,进入jar包所在目录(可以复制到其他位置),使用java -jar spring-boot-hello-0.0.1-SNAPSHOT.jarspring-boot-hello-0.0.1-SNAPSHOT.jar 就启动了项目,浏览器访问结果
    在这里插入图片描述

pom文件

  1. 父项目
<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>1.5.19.RELEASE</version>
</parent>

该项目的父项目(spring-boot-starter-parent)的父项目(spring-boot-dependencies)来管理Spring Boot应用里的所有依赖版本;版本由Spring Boot的版本仲裁中心决定。
以后导入依赖是不需要写版本的(没有在dependencies里管理的依赖需要声明版本号)
2. 导入的依赖

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

spring-boot-starter:spring-boot启动器;帮我们导入了web模块正常运行所依赖的组件;
Spring Boot将所有的功能场景都抽取出来,做成一个个的starters(启动器),只需要在项目中引用这些starters,相关场景的所有依赖都会导入进来。要用什么功能,就导入什么场景启动器。

主程序类

@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的配置类
— @Configuration: Spring的配置类
@EnableAutoConfiguration:开启自动配置功能
— @AutoConfigurationPackage 自动将@SpringBootConfiguration主程序所在的包和子包配置在Spring容器中

Spring Boot配置文件

Spring Boot可以采用两种配置文件,application.properties和application.yml
yml也是一种标记语言

server: 
	port: 8081

xml写法

<server>
	<port>8081</port>
</server>

properties写法

server.port=8081

application.properties

在这里插入图片描述

application.yml

语法格式
在这里插入图片描述
行内写法

配置文件属性注入

  1. @ConfigurationProperties
    在这里插入图片描述
  2. @Value
    在这里插入图片描述

@ConfigurationProperties与@Value比较

1. @ConfigurationProperties支持批量注入属性,@Value只能一个个注入
4.  @ConfigurationProperties支持松散绑定(大小写不规范)
5. @Value支持SpEl,@ConfigurationProperties不支持,如上面计算和函数
6. @ConfigurationProperties支持JSR303数据校验,@Value不支持
7. @ConfigurationProperties支持复杂类型封装

使用情况:
业务中需要获取配置文件中的某个值,用@Value
如果专门写了一个javaBean来和配置文件映射使用@ConfigurationProperties
在这里插入图片描述
结果可以注入
在这里插入图片描述
name必须为邮箱

  1. @PropertySource
    将student的配置属性移动到专门的配置文件
    在这里插入图片描述
  2. @ImportResource
    自己编写的spring.xml配置文件在Spring Boot中不生效,不能识别。
    想要生效需要将@ImportResource配置在主程序上
    在这里插入图片描述
    spring boot不推荐这样,spring boot推荐使用全注解形式。可以写注解类。
    在这里插入图片描述
配置文件占位符
  1. 随机数
  2. 占位符获取之前配置的值,如果没有可以使用:指定默认值
    在这里插入图片描述

环境切换

  1. 多个配置文件
    在这里插入图片描述
  2. application.properties中
    spring.profiles.active=dev来选择环境
    yml写法
    在这里插入图片描述
  3. 也可以在运行jar包时指定
    java -jar aaa.jar --spring.profiles.active=dev;
  4. 虚拟机参数
    -Dspring.profiles.active=dev;

配置文件优先级

  1. 项目下config/application.properties
  2. 项目下application.properties
  3. classpath:config/application.properties
  4. classpath:application.properties
    都配置的情况下,优先级高的会覆盖低的,其他采取互补机制

外部配置加载顺序

  1. 命令行加载
    java -jar aaa.jar --server.port=8084 --server.context-path=/aaa;
  2. jar包同目录下配置application.properties会覆盖内部配置
    具体有17种配置,可参考官方文档。

自动配置原理与可配置属性

配置文件可配置的属性参照
spring boot里有很多XXXAutoConfiguration自动配置类,有XXXPropertis封装配置文件的属性,可以修改
配置核心:

  1. Spring Boot启动会加载大量的自动配置类
  2. 我们需要的功能有没有Spring Boot默认写好的自动配置类
  3. 观察自动配置到底配置了什么
  4. 在配置文件中修改我们需要的属性的值
    有些自动配置类需要一定条件下才生效。
    可以在配置文件中写debug=true,在启动时,会打印启动和没有启动的配置类

Spring Boot日志

Spring Boot日志默认采用SLF4j和logback。

SLF4J使用

系统里面导入slf4j和logback的jar包

public class HelloWorld{
	public static void main(String[] args){
		Logger logger = LoggerFactory.getLogger(HelloWorld.class);
		logger.info("hello world");
	}
}

SpringBoot能适配所有的日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-core</artifactId>
	<exclusions>
		<exclusion>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
实际使用

Spring Boot默认配置好了日志

@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTests {
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
		//日志级别trace<debug<info<warn<error
		//可以调整输出的日志级别;
		logger.trace("这是trace日志。。。");
		logger.debug("这是debug日志。。。");
		//SpringBoot默认是Info级别
		logger.info("这是info日志。。。");
		logger.warn("这是warn日志。。。");
		logger.error("这是error日志。。。");
	}
}

可以在application.properties配置

logging.level.com.shyb=warn
#生成文件,不指定路径,生成在本项目里
logging.file=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

可以在reources下配置logback-spring.xml,SpringBoot就能解析,使用springProfile标签,根据环境生效日志内容,而且可以配置规则日志分类、清理多余日志等。只要使用springProperty找yml的logging.path时,配置一个logging.path即可
配置介绍

  • configuration 根目录
    • appender 负责写日志的组件
    • logger 设置某一个类的日志级别
    • root 根logger
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration  scan="true" scanPeriod="10 seconds">

    <contextName>logback</contextName>
    <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
    <!--  <property name="log.path" value="/home/log" /> -->
    <!-- property是直接写死日志输出地址,也可以在application.yml中配置,则配置如下-->
    <springProperty scope="context" name="log.path" source="logging.path"/>

    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>


    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--输出到文件-->

    <!-- 时间滚动输出 level为 DEBUG 日志 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_debug.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志归档 -->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 时间滚动输出 level为 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 时间滚动输出 level为 WARN 日志 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录warn级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 时间滚动输出 level为 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录ERROR级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
        以及指定<appender>。<logger>仅有一个name属性,
        一个可选的level和一个可选的addtivity属性。
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
              还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
              如果未设置此属性,那么当前logger将会继承上级的级别。
        addtivity:是否向上级logger传递打印信息。默认是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--
        使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
        第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
        第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:<!--<logger name="com.**.mapper" level="debug"/>-->
     -->
    <!--
        root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
        不能设置为INHERITED或者同义词NULL。默认是DEBUG
        可以包含零个或多个元素,标识这个appender将会添加到这个logger。
    -->

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
	    <root level="info">
	        <appender-ref ref="CONSOLE" />
	        <appender-ref ref="DEBUG_FILE" />
	        <appender-ref ref="INFO_FILE" />
	        <appender-ref ref="WARN_FILE" />
	        <appender-ref ref="ERROR_FILE" />
	    </root>
    </springProfile>

    <!--生产环境:输出到文件-->
    <springProfile name="prod">
	    <root level="info">
	        <appender-ref ref="CONSOLE" />
	        <appender-ref ref="DEBUG_FILE" />
	        <appender-ref ref="INFO_FILE" />
	        <appender-ref ref="WARN_FILE" />
	        <appender-ref ref="ERROR_FILE" />
	    </root>
    </springProfile>

</configuration>
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值