Springboot 学习总结

短命女 2022-11-18 04:40 232阅读 0赞

# SpringBoot入门教程 #

### 文章目录 ###

*  SpringBoot入门教程
 *   *  一、概述
     *  二、功能
     *  三、快速入门
     *  四、使用IDEA快速构建SpringBoot项目
     *  五、定义配置文件
     *  六、获取配置文件的值
     *  七、配置profile
     *  八、配置文件的加载
     *  九、整合其他框架
     *   *  1. 整合Junit
         *  2. 整合Redis
         *  3. 整合MySQL
         *   *  (1) 注解开发
             *  (2) 配置文件开发
     *  十、常用注解
     *   *  1. @Configuration、@Bean注解的使用
         *  2. @Import、@ConditionalOnxxx注解的使用
         *  3. @ImportResource、@EnableConfigurationProperties注解的使用
     *  十一、访问静态资源
     *  十二、首页和网页标签图标

## 一、概述 ##

SpringBoot并不是对Spring功能上的增强，而是提供了一种快速使用Spring的方式

## 二、功能 ##

1.  将许多需要的坐标打包在了一起，只需要依赖少量的整合坐标即可，且不会造成版本冲突
2.  提供了一些大型项目中常见的非功能性特性，如嵌入式服务器、安全、指标，外部配置等

## 三、快速入门 ##

1.  创建Maven项目
2.  导入SpringBoot起步依赖

<groupId>com.itheima</groupId>
    <artifactId>springboot-helloworld</artifactId>
    <version>1.0-SNAPSHOT</version>
    
    
    
    
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
    </parent>
    
    <dependencies>
        
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

1.  定义Controller

@RestController
    public class HelloController { 
        @RequestMapping("/hello")
        public String hello(){ 
            return " hello Spring Boot !";
        }
    }

1.  编写引导类

/** * 引导类是SpringBoot项目的入口，运行main方法即可启动项目 */
    @SpringBootApplication
    public class HelloApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(HelloApplication.class,args);
        }
    }

1.  运行main方法启动项目

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70]

1.  注意

(1) SpringBoot项目的打包方式为jar

(2) SpringBoot构建的项目，业务逻辑的编写方法和Spring完全一样

## 四、使用IDEA快速构建SpringBoot项目 ##

![在这里插入图片描述][20210412150027696.png]

![在这里插入图片描述][20210412150043474.png]

## 五、定义配置文件 ##

SpringBoot的很多配置都有默认值，如果要使用自定义配置代替默认配置，可以在application.yml 或application.yaml或application.properties中进行配置

1.  默认配置文件名称application(后缀三种均可)
2.  相同的配置在同一级目录下优先级为：properties > yml > yaml
3.  properties配置文件

示例：修改Tomcat端口号：

1.  yml配置文件

(1) 扩展名为 yml 或 yaml 用法一致

(2) 大小写敏感

(3) 数据值前边必须有空格，作为分隔符

(4) 使用缩进表示层级关系，相同的缩进表示同一级

(5) ‘’\#"表示注释，从这个字符一直到行尾，都会被解析器忽略

(6) 示例

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 1]

## 六、获取配置文件的值 ##

1.  方式一：使用注解

//表示键age的值赋予属性myAge
    @Value("${age}")
    private String myAge; 
    
    @Value("${person.name}")
    private String name2;
    
    @Value("${address[0]}")
    private String address1;
    
    @Value("${msg1}")
    private String msg1;

1.  方式二：使用Environment对象

//导入的包为springframework
    @Autowired
    private Environment env;
    
    System.out.println(env.getProperty("person.name"));
    System.out.println(env.getProperty("address[0]"));

1.  方式三：将配置内容和对象属性相互绑定

创建Person对象，属性的值引用配置文件的person中的同名key的值  
![在这里插入图片描述][202104121501592.png]

@Component
    @ConfigurationProperties(prefix = "person") 
    //必须加前缀person，否则获取的是普通kv
    public class Person { 
        private String name;
        private int age;
        private String[] address;
    }

1.  注意

如果提示以下错误，则需要在pom.xml中导入依赖  
![在这里插入图片描述][20210412150204388.png]

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

## 七、配置profile ##

开发SpringBoot应用时，通常一套程序会被安装到不同环境，如开发、测试、生产等；其中数据库 地址、服务器端口等配置都不同，如果每次打包时都需要修改配置文件，就会非常麻烦；profile的 作用就是进行动态的配置切换

1.  方式一：多profile文件

提供多个配置文件，每个表示一种环境

application-dev.properties (或yml) 开发环境  
application-test.properties (或yml) 测试环境  
application-pro.properties (或yml) 生产环境

在application配置文件中配置`spring.profiles.active=后缀名(dev、test、pro)`使用指定的配置

1.  方式二：使用yml配置

在yml文件中使用 ”—” 分割不同的配置

---
    #配置1
    #配置信息
    server:
      port: 8081
    
    #指定此配置的名称
    spring:
      profiles: dev
    ---
    #配置2
    server:
      port: 8082
    
    spring:
      profiles: test
    ---
    #选择使用的配置
    spring:
      profiles:
        active: dev

1.  激活profile的方式

(1) 配置文件激活，如上述

(2) 虚拟机参数，在VM options指定：`-Dspring.profiles.active=配置名称` (前提需要已在yml配置)

![在这里插入图片描述][20210412150256125.png]

(3) 命令行参数：`--spring.profiles.active=配置名称` (前提需要已在yml配置)

![在这里插入图片描述][20210412150305575.png]

(4) 将项目打成jar包之后运行时修改运行环境 (前提需要已在yml配置)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 2]

注：(2)(3)(4)的配置会覆盖(1)的配置

## 八、配置文件的加载 ##

区分两个位置：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 3]

1.  内部配置文件(application)的加载顺序

从上到下优先级降低，高优先级会覆盖低优先级的配置

(1) 当前项目的/config目录  
(2) 当前项目的根目录  
(3) classpath的/config目录  
(4) classpath的根目录

注：进入项目的根目录的方法

1.  外部配置 (会覆盖内部配置)

使用外部配置的好处是无需修改源文件，直接对jar包操作

(1) shell命令行

![在这里插入图片描述][20210412150341712.png]

(2) shell命令指定配置文件位置

![在这里插入图片描述][20210412150346189.png]

示例：

![在这里插入图片描述][20210412150348877.png]

(3) shell命令不指定任何参数

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 4]

## 九、整合其他框架 ##

### 1. 整合Junit ###

(1) 创建SpringBoot工程

(2) pom.xml中引入依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

(3) 编写测试类

@RunWith(SpringRunner.class)
    @SpringBootTest(classes = SpringbootTestApplication.class)
    public class UserServiceTest { 
        @Test
        public void test() { 
            //测试内容
        }
    }

(4) 注意

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 5]

### 2. 整合Redis ###

(1) 创建SpringBoot工程

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 6]

(2) pom.xml中引入依赖(使用(1)的快速构建则会自动导入)

<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>

(3) application.yml中编写配置

spring:
      redis:
        host: 127.0.0.1 # redis的主机ip
        port: 6379 # redis的端口号

(4) 编写测试类进行测试

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootRedisApplicationTests { 
    
        /** * 使用RedisTemplate操作Redis */
        @Autowired
        private RedisTemplate redisTemplate;
    
        @Test
        public void test() { 
            //设置键值对k1-v1
            redisTemplate.opsForValue().set("k1", "v1");
            //获取k1
            redisTemplate.opsForValue().get("k1");
        }
    }

(5) RedisTemplate的使用

![在这里插入图片描述][20210412150503279.png]

### 3. 整合MySQL ###

#### (1) 注解开发 ####

i. 创建SpringBoot项目

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 7]

ii. pom.xml中引入依赖 (使用(1)的快速构建则会自动导入)

<groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.0</version>
    
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>

iii. application.yml中编写配置

spring:
      datasource:
        url: jdbc:mysql:///springboot?serverTimezone=UTC
        username: root
        password: xxxx
        driver-class-name: com.mysql.cj.jdbc.Driver

iv. 编写Mapper接口

@Mapper
    @Repository /*无需使用此注解，但编译时报错*/
    public interface UserMapper { 
        @Select("select * from t_user")
        public List<User> findAll();
    }

v. 进行测试

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootMybatisApplicationTests { 
    
        @Autowired
        private UserMapper userMapper;
    
        @Test
        public void testFinadAll() { 
            List<User> list = userMapper.findAll();
            System.out.println(list);
        }
    }

#### (2) 配置文件开发 ####

i. 编写接口

@Mapper
    public interface UserXmlMapper { 
        public List<User> findAll();
    }

ii. 编写UserMapper.xml文件

<mapper namespace="com.itheima.springbootmybatis.mapper.UserXmlMapper">
        
        <select id="findAll" resultType="user">
            select * from t_user
        </select>
    </mapper>

iii. application.yml中编写配置

mybatis:
      mapper-locations: classpath:mapper/*Mapper.xml # mapper映射文件路径(相当于注册)
      type-aliases-package: com.itheima.springbootmybatis.domain #使用了别名
      # config-location: 指定mybatis的核心配置文件的位置，此处未使用

iv. 进行测试

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootMybatisApplicationTests { 
        
        @Autowired
        private UserXmlMapper userXmlMapper;
    
        @Test
        public void testFindAll2() { 
            List<User> list = userXmlMapper.findAll();
            System.out.println(list);
        }
    }

## 十、常用注解 ##

### 1. @Configuration、@Bean注解的使用 ###

1.  创建两个类(类均没有使用@Component之类的注解)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 8]

1.  创建配置类

/** * 1. @Configuration注解告诉SpringBoot这是一个配置类，相当于Spring中使用<bean>的xml容器 * 2. 配置类本身也是容器中的一个组件 */
    @Configuration
    public class MyConfig { 
        /** * 1. 使用@Bean注解表示给容器中添加组件，默认以方法名作为组件的id * 2. 使用@Bean("id名称")修改容器中的组件id * 3. 容器中的组件默认是单实例的，多次获取的为同一个 * @return 返回值为容器中的实例 */
        @Bean("tom")
        public Pet tomcatPet(){ 
            return new Pet("tomcat");
        }
    
        @Bean
        public User user01() { 
            User zhangsan = new User("zhangsan", 18);
            //User组件依赖Pet组件，由于单实例，User中的Pet与容器中的Pet一致
            zhangsan.setPet(tomcatPet());
            return zhangsan;
        }
    }

1.  创建引导类

@SpringBootApplication(scanBasePackages = "com.atguigu.boot")
    public class MainApplication { 
        public static void main(String[] args) { 
            //1、返回IOC容器
            ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
            //2、查看容器里面的组件
            String[] names = run.getBeanDefinitionNames();
            for (String name : names) { 
                System.out.println(name);
            }
            //3. 从容器中获取组件
            System.out.println(run.getBean("tom", Pet.class) == run.getBean("tom", Pet.class));
            //true
    
            //4. 配置类本身也是容器中的组件，默认得到的是CGLIB代理对象
            MyConfig bean = run.getBean(MyConfig.class);
            //代理对象调用方法默认会检查容器中是否有此方法，并返回单实例组件
            System.out.println(bean.user01() == bean.user01()); //true
        }
    }

1.  其他使用方式

@Configuration(proxyBeanMethods = true) //默认形式(true)，调用的组件都是单例的，称为Full模式
    @Configuration(proxyBeanMethods = false) //每个被调用的bean返回的都是新创建的，称为Lite模式

1.  方式的选择

(1) 类组件之间无依赖关系用Lite模式加速容器启动过程，不会判断容器中是否有此组件  
(2) 类组件之间有依赖关系，且获取的Bean要一致，使用Full模式

### 2. @Import、@ConditionalOnxxx注解的使用 ###

1.  @Import注解用在容器中的组件类上，用来导入组件，如：

//给容器中创建出这两个类型的组件，默认组件的名字是全类名
    @Import({ User.class, DBHelper.class})

1.  @ConditionalOnxxx注解

(1) 作用

条件装配，当满足某一条件时才执行某一操作(使用在类上，类中的所有操作；使用在方法 上，方法的操作)

(2) 派生的注解

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 9]

(3) 使用

i. 使用在方法上

//当容器中没有名为tom的组件时才添加Pet组件
    @ConditionalOnMissingBean(name = "tom")
    @Bean
    public Pet tomcatPet(){ 
        return new Pet("tomcat");
    }

ii. 使用在类上同理，满足某一条件时才可执行整个类的方法

### 3. @ImportResource、@EnableConfigurationProperties注解的使用 ###

1.  @ImportResource注解

使用在配置类上，用来导入Spring使用的xml配置文件，引入xml中的组件  
`@ImportResource("classpath:spring.xml")`

1.  @EnableConfigurationProperties注解

(1) 使用在配置类上  
(2) 将指定的类使用`@ConfigurationProperties`注解绑定配置文件的值  
(3) 将指定的类自动的注册到容器中(类无需再使用@Component注解)

`@EnableConfigurationProperties(User.class)`

## 十一、访问静态资源 ##

1.  直接访问静态资源的方式

只要静态资源(如css、jpg等)放在类路径下的/static或/public或/resources/或/META-INF/resources 目录下，直接使用`localhost:xxxx/[context path]/资源名`即可访问到

1.  原理

当请求发起时，首先判断`@Controller`中是否有匹配的请求，若无，去判断静态资源是否满足  
(当`@RequestMapping`中请求路径与资源同名，优先处理`@Controller`)

1.  修改资源的请求路径

application.yml中修改

#浏览器输入localhost:xxxx/[context path]/res/资源名才可以访问到
    spring:
      mvc:
        static-path-pattern: /res/**

1.  修改资源的默认位置

#静态资源必须放在类路径下的/haha目录才可直接访问
    spring:
      resources:
        static-locations: [classpath:/haha/]

## 十二、首页和网页标签图标 ##

1.  首页的自动加载

把名为index.html的页面放在静态资源的目录下，输入`localhost:xxxx/[context path]`即可自动 访问index.html页面

1.  网页标签图标的加载

把名为`favicon.ico`的图标放在静态资源的目录下，访问页面时可自动加载图标

1.  注意

修改默认资源的请求路径会导致上述无法自动加载

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70]: /images/20221022/48ec3bd922d44a1cbc0b81ca9d4f118f.png
[20210412150027696.png]: /images/20221022/88d865b3a5094bbfb64ae1aba35fb647.png
[20210412150043474.png]: /images/20221022/7f958415bb0f4c96bc9d78cec8e7b6d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 1]: /images/20221022/0273eaa5a4354ecdb3a4ecd4c35f5872.png
[202104121501592.png]: /images/20221022/aa3e4e53ead44c25ae525c762fea9b5c.png
[20210412150204388.png]: /images/20221022/04dc14fdc12b43eeb940ad5fb3b418ef.png
[20210412150256125.png]: /images/20221022/01d6327ba2d9422f9b3831fd1face25f.png
[20210412150305575.png]: /images/20221022/e4aab014d39f47a983416a6800ca322e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 2]: /images/20221022/5a97b5dd72b74c3f9f6758a987eeb1e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 3]: /images/20221022/4b481d4418f4429abebc6e1568814fee.png
[20210412150341712.png]: /images/20221022/3e4e7a9f0b6a4ef09b351fa55473b054.png
[20210412150346189.png]: /images/20221022/7780f8e7cce14c5ab05d7333b539ef0b.png
[20210412150348877.png]: /images/20221022/26651b5bf1ee4fb9a26b0e9bc01827e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 4]: /images/20221022/1a831348761347cf8883725a8f70514c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 5]: /images/20221022/188d6ff3c8d34a898683dde8d9bb622d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 6]: /images/20221022/c31750401d924efb93abd10b34a4ae00.png
[20210412150503279.png]: /images/20221022/9beaaeb6e0c34a6fa5aa757852571491.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 7]: /images/20221022/a5066a50011045e9b47b2d054232c889.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 8]: /images/20221022/14872cbba57a4d39a4c365c95f8b764a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 9]: /images/20221022/4a217c9135fc40d8aedcb19636851e37.png