SpringBoot入门

参考资料：
官方参考文档
Spring Boot 入门之基础篇（一)

1.简单介绍

Spring Boot可以轻松创建可以运行的独立的、生产级的基于Spring的应用程序。SpringBoot对Spring平台和第三方库进行了一些通用的默认配置，这样用户就可以轻松上手了。大多数Spring Boot应用程序只需要很少的Spring配置。

SpringBoot主要目标是：

• 为所有Spring开发提供从根本上更快且可广泛访问的入门体验。
• 开箱即用，但随着需求开始偏离默认值而迅速摆脱困境。
• 提供大型项目（例如嵌入式服务器，安全性，度量标准，运行状况检查和外部化配置）通用的一系列非功能性功能。
• 绝对没有代码生成，也不需要XML配置。

2.版本要求

版本要求.png

3.入门程序

打开IDEA开发工具，新建项目，在项目下新建Module，选择spring initializr

图片.png

一些信息随意填写

图片.png

这里有许多可以在初始化时进行集成的选项，简单入门只勾选一个spring web starter即可

图片.png

下一步

图片.png

创建完成后首先打开pom.xml文件来看一下

图片.png

看一下项目结构

图片.png

编写一个简单的HelloWorld控制器，进行测试

图片.png

测试结果

图片.png

4.热部署

我们在开发中反复修改类、页面等资源，每次修改后都是需要重新启动才生效，这样每次启动都很麻烦，浪费了大 量的时间，我们可以在修改代码后不重启就能生效，在 pom.xml 中添加如下配置就可以实现这样的功能，我们称 之为热部署

   <!--热部署配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>

注意：IDEA进行SpringBoot热部署失败原因
出现这种情况，并不是热部署配置问题，其根本原因是因为Intellij IEDA默认情况下不会自动编译，需要对IDEA进 行自动编译的设置，如下：

图片.png

5.多环境切换

application.properties 是 springboot 在运行中所需要的配置信息。
当我们在开发阶段，使用自己的机器开发，测试的时候需要用的测试服务器测试，上线时使用正式环境的服务器。
这三种环境需要的配置信息都不一样，当我们切换环境运行项目时，需要手动的修改多出配置信息，非常容易出错。
为了解决上述问题，springboot 提供多环境配置的机制，让开发者非常容易的根据需求而切换不同的配置环境。可以采用.yaml或者.properties方式进行切换配置

图片.png

在 src/main/resources 目录下创建三个配置文件:

application-dev.properties：用于开发环境
application-test.properties：用于测试环境
application-prod.properties：用于生产环境

我们可以在这个三个配置文件中设置不同的信息，application.properties 配置公共的信息。
在 application.properties 中配置：

  spring.profiles.active=dev

表示激活 application-dev.properties 文件配置， springboot 会加载使用 application.properties 和 application-dev.properties 配置文件的信息。
同理，可将 spring.profiles.active 的值修改成 test 或 prod 达到切换环境的目的。

6.日志配置

6.1 配置 logback（官方推荐使用）
spring boot 默认会加载 classpath:logback-spring.xml 或者 classpath:logback-spring.groovy。
如需要自定义文件名称，在 application.properties 中配置 logging.config 选项即可。
在 src/main/resources 下创建 logback-spring.xml 文件，内容如下

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        <!-- 文件输出格式 -->
        <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
        <!-- test文件路径 -->
        <property name="TEST_FILE_PATH" value="d:/test.log" />
        <!-- pro文件路径 -->
        <property name="PRO_FILE_PATH" value="/opt/test/log" />
        
        <!-- 开发环境 -->
        <springProfile name="dev">
            <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
                <encoder>
                    <pattern>${PATTERN}</pattern>
                </encoder>
            </appender>
            <logger name="com.light.springboot" level="debug" />
            <root level="info">
                <appender-ref ref="CONSOLE" />
            </root>
        </springProfile>
        
        <!-- 测试环境 -->
        <springProfile name="test">
            <!-- 每天产生一个文件 -->
            <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <!-- 文件路径 -->
                <file>${TEST_FILE_PATH}</file>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <!-- 文件名称 -->
                    <fileNamePattern>${TEST_FILE_PATH}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
                    <!-- 文件最大保存历史数量 -->
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${PATTERN}</pattern>
                </layout>
            </appender>
            <root level="info">
                <appender-ref ref="TEST-FILE" />
            </root>
        </springProfile>
        
        <!-- 生产环境 -->
        <springProfile name="prod">
            <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <file>${PRO_FILE_PATH}</file>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <fileNamePattern>${PRO_FILE_PATH}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${PATTERN}</pattern>
                </layout>
            </appender>
            <root level="warn">
                <appender-ref ref="PROD_FILE" />
            </root>
        </springProfile>
    </configuration>

其中，springProfile 标签的 name 属性对应 application.properties 中的 spring.profiles.active 的配置。
即 spring.profiles.active 的值可以看作是日志配置文件中对应的 springProfile 是否生效的开关。

6.2配置 log4j2

• 添加依赖

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

• 添加log4j2的配置文件
  spring boot 默认会加载 classpath:log4j2.xml 或者 classpath:log4j2-spring.xml。
  如需要自定义文件名称，在 application.properties 中配置 logging.config 选项即可。
  log4j2.xml 文件内容如下：

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
        <properties>
            <!-- 文件输出格式 -->
            <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>
        </properties>
        <appenders>
            <Console name="CONSOLE" target="system_out">
                <PatternLayout pattern="${PATTERN}" />
            </Console>
        </appenders>
        <loggers>
            <logger name="com.light.springboot" level="debug" />
            <root level="info">
                <appenderref ref="CONSOLE" />
            </root>
        </loggers>
    </configuration>

log4j2 不能像 logback 那样在一个文件中设置多个环境的配置数据，只能命名 3 个不同名的日志文件，分别在 application-dev，application-test 和 application-prod 中配置 logging.config 选项。
除了在日志配置文件中设置参数之外，还可以在 application-*.properties 中设置，日志相关的配置：

    logging.config                    # 日志配置文件路径，如 classpath:logback-spring.xml
    logging.exception-conversion-word # 记录异常时使用的转换词
    logging.file                      # 记录日志的文件名称，如：test.log
    logging.level.*                   # 日志映射，如：logging.level.root=WARN，logging.level.org.springframework.web=DEBUG
    logging.path                      # 记录日志的文件路径，如：d:/
    logging.pattern.console           # 向控制台输出的日志格式，只支持默认的 logback 设置。
    logging.pattern.file              # 向记录日志文件输出的日志格式，只支持默认的 logback 设置。
    logging.pattern.level             # 用于呈现日志级别的格式，只支持默认的 logback 设置。
    logging.register-shutdown-hook    # 初始化时为日志系统注册一个关闭钩子

7.打包方式

• 7.1 打包成可执行的 jar 包
  默认情况下，通过 maven 执行 package 命令后，会生成 jar 包，且该 jar 包会内置了 tomcat 容器，因此我们可以通过 java -jar 就可以运行项目，如下图：

  
  图片.png
• 7.2 打包成部署的 war 包
  让 SpringbootApplication 类继承 SpringBootServletInitializer 并重写 configure 方法，如下：

    @SpringBootApplication
    public class SpringbootApplication extends SpringBootServletInitializer {

        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(SpringbootApplication.class);
        }

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

修改 pom.xml 文件，将 jar 改成 war，如下：

<packaging>war</packaging>

打包成功后，将 war 包部署到 tomcat 容器中运行即可

8.SpringBoot配置默认首页

当我们不指定首页时，springboot会去静态资源路径下寻找index.html

2.0版本的配置

@Configuration
public class DefaultView implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
//        // login页面在 templates 文件夹下
        registry.addViewController("/").setViewName("login");
    }
}

1.0版本的配置

@Configuration
public class DefaultView extends WebMvcConfigurerAdapter {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
    // login页面在 templates 文件夹下
        registry.addViewController("/").setViewName("login");
        registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
        super.addViewControllers(registry);
    }
}

9.springboot2.x放行静态资源

@Configuration
public class WelcomePage implements WebMvcConfigurer {

 @Override
 public void addViewControllers(ViewControllerRegistry registry) {
     registry.addViewController("/").setViewName("login");
 }

 @Override
 public void addResourceHandlers(ResourceHandlerRegistry registry) {
     // 放行静态资源
    //包含/static/的请求去classpath:/static/找相关资源
     registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
 }
}

10.国际化

10.1 springboot做了默认配置，当我们不指定国际化资源时，它会找messages...的资源

image.png

10.2 我们可以配置指定的名称开头的国际化资源文件

spring:
  messages:
    basename: i18n.home

可以根据支持不同的语言加入不同的配置

image.png