SpringBoot 基本使用

Love The Way You Lie 2023-02-11 10:21 14阅读 0赞

### 目录 ###

*   *   *  热部署
         *   *  方式一 Spring Boot DevTools
             *  方式二 使用JRebel插件
         *  web静态资源的存放
         *  设置json数据的日期时间格式
         *  yaml 配置文件
         *   *  yaml语法
             *  使用@Value注入简单类型的配置
             *  使用@ConfigurationProperties注入对象类型的配置
             *  Spring Configuration Processor 自定义配置项的提示
             *  注入说明
         *  配置多种环境
         *  加载、解析依赖中的spring|springboot注解
         *  运行项目的多个实例
         *  资源文件的拷贝问题
         *  读取resources下的文件
         *  常见问题
         *   *  运行、打包springboot项目时报错：找不到主类

### 热部署 ###

相关问题

*  如何重新加载spring boot上的更改，而无需重启服务器？
 *  spring boot项目如何热部署？

常用有2种方式

*  Spring Boot DevTools：监听文件修改，修改代码后自动重启应用，需要重新部署整个应用，耗时较长，不推荐
 *  使用JRebel插件：支持本地热部署、远程服务器的热部署，修改代码后 Ctrl+Shift+F9 一键同步部署，只重新部署修改的部分、不重启应用，速度快，推荐。

都支持web静态资源的自动刷新，Spring Boot DevTools 刷新web静态资源无需重启应用。

#### 方式一 Spring Boot DevTools ####

spring boot devtools 需要IDE自动编译的支持，先配置IDE的自动编译、运行时自动编译。

1、Settings -> Build，Execution，Deployment -> Compiler -> 勾选自动编译  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70]  
   
2、Ctrl+Shift+Alt+/ -> Registry -> 勾选运行时自动编译  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 1]

3、后续创建springboot项目时勾选 Developer Tools -> Spring Boot DevTools，或手动添加 spring-boot-devtools 的依赖，即可实现热部署

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>

#### 方式二 使用JRebel插件 ####

1、安装插件 JRebel and XRebel for Intellij

高版本的IDEA自带此插件，无需手动安装

2、激活JRebel

[https://www.guidgen.com/][https_www.guidgen.com] \-> 复制GUID

JRebel Activation -> Team URL -> 填写 https://jrebel.qekang.com/\{GUID\}、邮箱，邮箱可以瞎填

3、点击右上角的JRebel运行应用，修改代码后 Ctrl+Shift+F9 同步更改

### web静态资源的存放 ###

springboot默认的web静态资源存放位置有4个

*  classpath:/static
 *  classpath:/public
 *  classpath:/resources
 *  classpath:/META-INF/resources

一般是在resources下新建static文件夹存放web静态资源。

### 设置json数据的日期时间格式 ###

在application.yml中统一设置，不必在实体类的每个Date字段上加@JsonFormat。

使用的仍是springmvc内置的jackson，无需添加额外的依赖。

#配置json时间日期格式
    spring:
      jackson:
        date-format: yyyy-MM-dd HH:mm:ss
        time-zone: GMT+8

### yaml 配置文件 ###

#### yaml语法 ####

冒号后面加一个空格，字符串类型的值加不加引号均可

#普通字段
    id: 1
    name: chy
    
    
    #对象
    user:
      id: 1
      name: chy
    
    
    # 数组 | list | set
    city: beijing,shanghai,guangzhou,shenzhen
    
    
    #支持嵌套，对象可以嵌套对象、数组，数组可以嵌套数组、对象
    student:
      id: 1
      name: chy
      teacher: zhangsan,lisi,wangwu
      socre: 
        chinese: 90
        math: 100
        english: 80

可以写预定义的配置项，也可以写自定义的配置项，注入时也一样。

#### 使用@Value注入简单类型的配置 ####

此处的@Value是spring的注解，不是lombok的

@Configuration  //需要标识为@Component体系的组件，@Value才会被扫描、解析
    public class Config { 
    
        @Value("${id}")  //注入普通字段
        private int id;
    
        @Value("${user.name}")  //注入对象的属性值
        private String username;
    
        @Value("${city}")  //注入数组
        private String[] cityArr;
    
        @Value("${city}")  //注入list
        private List<String> cityList;
    
        @Value("${city}")  //注入set
        private Set<String> citySet;
    
    }

springboot会自动转换为需要的类型

#### 使用@ConfigurationProperties注入对象类型的配置 ####

会自动注入与成员变量名同名的配置项

@Data  //需要提供setter方法用于注入
    @Configuration  //需要用@Component体系注解标注，放到容器中
    @ConfigurationProperties("upload")  //指定配置项前缀，value、prefix属性互为别名，都可以指定配置项前缀
    public class UploadConfig { 
    
        private int maxFileSize;
        
        private String savaDir;
        
        //.....
        
    }

#### Spring Configuration Processor 自定义配置项的提示 ####

在创建springboot项目时，可以勾选 Developer Tools -> Spring Configuration Processor，或手动添加 Spring Configuration Processor 的依赖

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

这样先使用@ConfigurationProperties编写配置类，在properties、yml中写配置时，对应的配置项会有代码提示

#### 注入说明 ####

1、@Value、@ConfigurationProperties 都只能注入到普通的实例成员上，不能注入到 final修饰的成员上，也不能直接注入到 static 修饰的成员变量上，但可以使用实例方法的方式间接注入到static成员变量上

@Configuration
    public class UploadConfig { 
    
        public static String saveDir;  //不能用final修饰，不然注入不了
    
        @Value("${upload.saveDir}")  //标注在实例方法上。方法不能用static修饰，否则注入不了
        public void setSaveDir(String saveDir) { 
            UploadConfig.saveDir = saveDir;
        }
    
        //.....
    
    }

2、@Value、@ConfigurationProperties 都只能注入配置文件中的显式配置

eg. 在配置文件中显式配置了 server.port，才能注入 server.port；没在配置文件中显式配置 server.port，虽然springboot有这个配置项、也有默认值，但@Value、@ConfigurationProperties不会注入springboot自动配置指定的默认值。

3、@Value可以用 $\{ \} 取配置文件中的值，也可以使用SpEL \#\{ \} 。

@Value("#{2+3}")  // #{}
    private int n;
    
    @Value("${server.port}")  // ${}
    private String port;

$\{ \}、\#\{ \} 也可以在模板引擎的页面中用于取值

### 配置多种环境 ###

1、resources下新建配置文件，文件名格式为 application-xxx，示例

*  application-dev.yml：开发
 *  application-test.yml：测试
 *  application-prod.yml：生产

2、application.yml中指定要使用的配置文件

spring:
      profiles:
      	#值是application-后面的部分，可以指定多个配置文件，有多个配置文件时逗号分隔
        active: dev

application.yml是公共的，开发、测试、生产环境都会加载使用，用于编写公共配置，如果配置很多可以拆分到多个配置文件中，然后在application.yml中用 spring.profiles.include 引入。

profiles 意为 配置文件，active用于区分环境，include用于引入公共配置，其实二者作用是一样的，都是引入指定的配置文件，设置为2个配置项只是为了语义上的区分，好比html的布局标签<nav>、<aside>、<footer>\`，本身都是<div>，效果完全相同，只是语义上的区分。

**说明**

可以在执行jar包时指定配置项，命令行参数优先级最高，会覆盖application.yml中同名的配置项

java -jar xxx.jar --spring.profiles.active=dev --server.port=9000

### 加载、解析依赖中的spring|springboot注解 ###

引导类上的 @SpringBootApplication 中包含了 @ComponentScan，但默认只扫描引导类同级目录下的组件，不会扫描依赖中的组件。

写基础模块时，有时候为了方便会直接使用spring|springboot来写，使用一些spring|springboot的注解。引入这种依赖包时，需要在引导类上显式配置 @ComponentScan，把要扫描的依赖中的包也加进去

//指定 项目本身 + 依赖 中要扫描的包
    @ComponentScan({ "com.xxx.xxx1", "com.xxx.xxx2"})

### 运行项目的多个实例 ###

勾选Allow parallel run  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 2]  
修改项目使用的端口号有2种方式

*  在VM options中指定，示例： -Dserver.port=9000
 *  在Program arguments中指定，示例：–server.port=9000，注意此处是2根短横

这2种方式均会覆盖配置文件中指定的端口号。

### 资源文件的拷贝问题 ###

运行、打包时resources下很多自定义的文件夹、文件都不会自动拷贝，需要我们配置一下pom.xml

<build>
    
        
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>
    
    </build>

如果已存在输出目录target文件夹，需要先删除target文件夹才会生效

### 读取resources下的文件 ###

假设要读取的文件是 resources/template/1.txt

// 方式一 开头不加/
    ClassPathResource classPathResource = new ClassPathResource("template/1.txt");
    InputStream is = classPathResource.getInputStream();
    
    
    // 方式二 开头要加/
    InputStream is = this.getClass().getResourceAsStream("/template/1.txt");

### 常见问题 ###

#### 运行、打包springboot项目时报错：找不到主类 ####

可以尝试以下三种方式

*  清除缓存后重启IDEA
 *  mvn clean compile，重新编译
 *  在pom.xml中显式指定主类

<plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
            
            <mainClass>com.chy.mall.MallApplication</mainClass>
        </configuration>
    </plugin>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200523101337249.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200523101727314.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ==,size_16,color_FFFFFF,t_70
[https_www.guidgen.com]: https://www.guidgen.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200531191716641.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ==,size_16,color_FFFFFF,t_70