美文网首页Javaspring boot
Spring Boot入门&整合常用框架整理丨深度好文

Spring Boot入门&整合常用框架整理丨深度好文

作者: Java_苏先生 | 来源:发表于2019-10-08 14:08 被阅读0次

    一、SpringBoot简介

    1.1 原有Spring优缺点分析

    1.1.1 Spring的优点分析

    Spring是Java企业版(Java Enterprise Edition,JEE,也称J2EE)的轻量级代替品。无需开发重量级的Enterprise JavaBean(EJB),Spring为企业级Java开发提供了一种相对简单的方法,通过依赖注入和面向切面编程,用简单的Java对象(Plain Old Java Object,POJO)实现了EJB的功能。

    1.1.2 Spring的缺点分析

    虽然Spring的组件代码是轻量级的,但它的配置却是重量级的。一开始,Spring用XML配置,而且是很多XML配置。Spring 2.5引入了基于注解的组件扫描,这消除了大量针对应用程序自身组件的显式XML配置。Spring 3.0引入了基于Java的配置,这是一种类型安全的可重构配置方式,可以代替XML。

    所有这些配置都代表了开发时的损耗。因为在思考Spring特性配置和解决业务问题之间需要进行思维切换,所以编写配置挤占了编写应用程序逻辑的时间。和所有框架一样,Spring实用,但与此同时它要求的回报也不少。

    除此之外,项目的依赖管理也是一件耗时耗力的事情。在环境搭建时,需要分析要导入哪些库的坐标,而且还需要分析导入与之有依赖关系的其他库的坐标,一旦选错了依赖的版本,随之而来的不兼容问题就会严重阻碍项目的开发进度。

    1.2 SpringBoot的概述

    1.2.1 SpringBoot解决上述Spring的缺点

    SpringBoot对上述Spring的缺点进行的改善和优化,基于约定优于配置的思想,可以让开发人员不必在配置与逻辑业务之间进行思维的切换,全身心的投入到逻辑业务的代码编写中,从而大大提高了开发的效率,一定程度上缩短了项目周期。

    1.2.2 SpringBoot的特点

    为基于Spring的开发提供更快的入门体验

    开箱即用,没有代码生成,也无需XML配置。同时也可以修改默认值来满足特定的需求提供了一些大型项目中常见的非功能性特性,如嵌入式服务器、安全、指标,健康检测、外部配置等

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

    1.2.3 SpringBoot的核心功能

    起步依赖

    起步依赖本质上是一个Maven项目对象模型(Project Object Model,POM),定义了对其他库的传递依赖,这些东西加在一起即支持某项功能。
    简单的说,起步依赖就是将具备某种功能的坐标打包到一起,并提供一些默认的功能。

    自动配置

    Spring Boot的自动配置是一个运行时(更准确地说,是应用程序启动时)的过程,考虑了众多因素,才决定Spring配置应该用哪个,不该用哪个。该过程是Spring自动完成的。

    注意:起步依赖和自动配置的原理剖析会在第三章《SpringBoot原理分析》进行详细讲解

    二、SpringBoot快速入门

    2.1 代码实现

    2.1.1 创建Maven工程

    使用idea工具创建一个maven工程,该工程为普通的java工程即可

    2.1.2 添加SpringBoot的启动器

    SpringBoot要求,项目要继承SpringBoot的起步依赖spring-boot-starter-parent

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

    指定使用的jdk版本

    <properties>
        <java.version>1.8</java.version>
    </properties>
    

    SpringBoot要集成SpringMVC进行Controller的开发,所以项目要导入web的启动依赖

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

    2.1.3 编写SpringBoot引导类

    要通过SpringBoot提供的引导类起步SpringBoot才可以进行访问

    package com.test;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    @SpringBootApplication
    public class MySpringBootApplication {
        public static void main(String[] args) {
            SpringApplication.run(MySpringBootApplication.class);
        }
    }
    

    2.1.4 编写Controller

    在引导类MySpringBootApplication同级包或者子级包中创建QuickStartController

    package com.test.controller;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    @Controller
    public class QuickStartController {
        @RequestMapping("/quick")
            @ResponseBody
            public String quick(){
            return "springboot 访问成功!";
        }
    }
    

    2.1.5 测试

    • 启动方式一:启动MySpringBootApplication类中的main方法
    • 启动方式二:使用Maven命令spring-boot:run执行即可

    控制台打印日志如下:

    通过日志发现,Tomcat started on port(s): 8080 (http) with context path ''

    tomcat已经起步,端口监听8080,web应用的虚拟工程名称为空

    打开浏览器访问url地址为:http://localhost:8080/quick

    三、SpringBoot深度体验

    3.1 整合Spring Data JPA

    3.1.1 添加Spring Data JPA的启动器

    <!-- springBoot JPA的起步依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    

    3.1.2 添加数据库驱动依赖

    <!-- MySQL连接驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    

    3.1.3创建数据库

    创建一个数据库,并在数据库中创建user表

    -- ----------------------------
    -- Table structure for `user`
    -- ----------------------------
    DROP TABLE IF EXISTS `user`;
    CREATE TABLE `user` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `username` varchar(50) DEFAULT NULL,
      `password` varchar(50) DEFAULT NULL,
      `name` varchar(50) DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=10 DEFAULT CHARSET=utf8;
    -- ----------------------------
    -- Records of user
    -- ----------------------------
    INSERT INTO `user` VALUES ('1', 'zhangsan', '123', '张三');
    INSERT INTO `user` VALUES ('2', 'lisi', '123', '李四');
    

    3.1.4 创建配置文件

    在maven工程的man/java/resources目录下创建名为“application.properties”的配置文件,其中配置数据库和jpa的相关属性

    #DB Configuration:
    spring.datasource.driverClassName=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf8
    spring.datasource.username=root
    spring.datasource.password=root
    
    #JPA Configuration:
    spring.jpa.database=MySQL
    spring.jpa.show-sql=true
    spring.jpa.generate-ddl=true
    spring.jpa.hibernate.ddl-auto=update
    

    3.1.5 创建实体配置实体

    @Entity
    public class User {
        // 主键
        @Id
            @GeneratedValue(strategy = GenerationType.IDENTITY)
            private long id;
        // 用户名
        private String username;
        // 密码
        private String password;
        // 姓名
        private String name;
        //此处省略setter和getter方法... ...
    }
    

    3.1.6 编写UserDao

    public interface UserDao extends JpaRepository<User, long> {
    }
    

    3.1.7 编写Controller

    @RestController
    public class UserController {
        @Autowired
            private UserService userService;
        @RequestMapping("/user/{id}")
            private User getUserById(@PathVariable long id) {
            User user = userService.getUserById(id);
            return  user;
        }
    }
    

    3.2 添加页面

    Springboot中不推荐使用jsp。所以表现层页面可以使用模板引擎实现。Spring Boot支持的模板类型有: velocity、freemarker、Thymeleaf等 其中对velocity的支持以及设置成过期状态,也就意味中springboot已经抛弃的velocity,所以在springboot中如果要编写页面的话应该使用freemarker或者Thymeleaf,本教程中使用freemarker。

    3.2.1添加freemarker的依赖

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

    3.2.2编写freemarker模板

    注意:模板必须放到src/main/resources/templates目录下。并且模板扩展名必须为ftl。

    <html>
    <head>
        <title>hello springboot</title>
    </head>
    <body>
    用户列表:<br>
    <table border="1">
        <tr>
            <th>id</th>
            <th>username</th>
            <th>password</th>
            <th>name</th>
        </tr>
            <#list userList as user>
            <tr>
                <td>${user.id}</td>
                <td>${user.username}</td>
                <td>${user.password}</td>
                <td>${user.name}</td>
            </tr>
            </#list>
    </table>
    </body>
    </html>
    

    3.2.3访问静态资源

    网页中可能会用到,图片、css、js等静态资源。

    需要把静态资源放到src/main/resources下的static目录下

    访问静态资源:

    四、SpringBoot原理分析

    4.1 起步依赖原理分析

    4.1.1 分析spring-boot-starter-parent

    按住Ctrl点击pom.xml中的spring-boot-starter-parent,跳转到了spring-boot-starter-parent的pom.xml,xml配置如下(只摘抄了部分重点配置):

    <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-dependencies</artifactId>
      <version>2.0.2.RELEASE</version>
      <relativePath>../../spring-boot-dependencies</relativePath>
    </parent>
    

    按住Ctrl点击pom.xml中的spring-boot-starter-dependencies,跳转到了spring-boot-starter-dependencies的pom.xml,xml配置如下(只摘抄了部分重点配置):

    <properties>
        <activemq.version>5.15.3</activemq.version>
        <antlr2.version>2.7.7</antlr2.version>
        <appengine-sdk.version>1.9.63</appengine-sdk.version>
        <artemis.version>2.4.0</artemis.version>
        <aspectj.version>1.8.13</aspectj.version>
        <assertj.version>3.9.1</assertj.version>
        <atomikos.version>4.0.6</atomikos.version>
        <bitronix.version>2.1.4</bitronix.version>
        <build-helper-maven-plugin.version>3.0.0</build-helper-maven-plugin.version>
        <byte-buddy.version>1.7.11</byte-buddy.version>
        ... ... ...
    </properties>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot</artifactId>
                <version>2.0.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-test</artifactId>
                <version>2.0.2.RELEASE</version>
            </dependency>
            ... ... ...
        </dependencies>
    </dependencyManagement>
    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.jetbrains.kotlin</groupId>
                    <artifactId>kotlin-maven-plugin</artifactId>
                    <version>${kotlin.version}</version>
                </plugin>
                <plugin>
                    <groupId>org.jooq</groupId>
                    <artifactId>jooq-codegen-maven</artifactId>
                    <version>${jooq.version}</version>
                </plugin>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.0.2.RELEASE</version>
                </plugin>
                ... ... ...
            </plugins>
        </pluginManagement>
    </build>
    

    从上面的spring-boot-starter-dependencies的pom.xml中我们可以发现,一部分坐标的版本、依赖管理、插件管理已经定义好,所以我们的SpringBoot工程继承spring-boot-starter-parent后已经具备版本锁定等配置了。所以起步依赖的作用就是进行依赖的传递。

    4.1.2 分析spring-boot-starter-web

    按住Ctrl点击pom.xml中的spring-boot-starter-web,跳转到了spring-boot-starter-web的pom.xml,xml配置如下(只摘抄了部分重点配置):

    <?xml version="1.0" encoding="UTF-8"?>
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starters</artifactId>
            <version>2.0.2.RELEASE</version>
        </parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.0.2.RELEASE</version>
        <name>Spring Boot Web Starter</name>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>2.0.2.RELEASE</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-json</artifactId>
                <version>2.0.2.RELEASE</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
                <version>2.0.2.RELEASE</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.hibernate.validator</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>6.0.9.Final</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>5.0.5.RELEASE</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>5.0.5.RELEASE</version>
                <scope>compile</scope>
            </dependency>
        </dependencies>
    </project>
    

    从上面的spring-boot-starter-web的pom.xml中我们可以发现,spring-boot-starter-web就是将web开发要使用的spring-web、spring-webmvc等坐标进行了“打包”,这样我们的工程只要引入spring-boot-starter-web起步依赖的坐标就可以进行web开发了,同样体现了依赖传递的作用。

    4.2 自动配置原理解析

    按住Ctrl点击查看启动类MySpringBootApplication上的注解@SpringBootApplication

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

    注解@SpringBootApplication的源码

    @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 {
    
        /**
         * Exclude specific auto-configuration classes such that they will never be applied.
         * @return the classes to exclude
         */
        @AliasFor(annotation = EnableAutoConfiguration.class)
        Class<?>[] exclude() default {};
    
        ... ... ...
    
    }
    

    其中,

    • @SpringBootConfiguration:等同与@Configuration,既标注该类是Spring的一个配置类
    • @EnableAutoConfiguration:SpringBoot自动配置功能开启

    按住Ctrl点击查看注解@EnableAutoConfiguration

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import(AutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration {
        ... ... ...
    }
    

    其中,@Import(AutoConfigurationImportSelector.class) 导入了AutoConfigurationImportSelector类

    按住Ctrl点击查看AutoConfigurationImportSelector源码

    public String[] selectImports(AnnotationMetadata annotationMetadata) {
            ... ... ...
            List<String> configurations = getCandidateConfigurations(annotationMetadata,
                                                                       attributes);
            configurations = removeDuplicates(configurations);
            Set<String> exclusions = getExclusions(annotationMetadata, attributes);
            checkExcludedClasses(configurations, exclusions);
            configurations.removeAll(exclusions);
            configurations = filter(configurations, autoConfigurationMetadata);
            fireAutoConfigurationImportEvents(configurations, exclusions);
            return StringUtils.toStringArray(configurations);
    }
    
    
    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
                AnnotationAttributes attributes) {
            List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
                    getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
            
            return configurations;
    }
    

    其中,SpringFactoriesLoader.loadFactoryNames 方法的作用就是从META-INF/spring.factories文件中读取指定类对应的类名称列表

    spring.factories 文件中有关自动配置的配置信息如下:

    ... ... ...
    
    org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
    org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
    org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
    org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
    org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
    org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
    
    ... ... ...
    

    上面配置文件存在大量的以Configuration为结尾的类名称,这些类就是存有自动配置信息的类,而SpringApplication在获取这些类名后再加载

    我们以ServletWebServerFactoryAutoConfiguration为例来分析源码:

    @Configuration
    @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
    @ConditionalOnClass(ServletRequest.class)
    @ConditionalOnWebApplication(type = Type.SERVLET)
    @EnableConfigurationProperties(ServerProperties.class)
    @Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
            ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
            ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
            ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
    public class ServletWebServerFactoryAutoConfiguration {
        ... ... ...
    }
    

    其中,

    @EnableConfigurationProperties(ServerProperties.class) 代表加载ServerProperties服务器配置属性类

    进入ServerProperties.class源码如下:

    @ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
    public class ServerProperties {
    
        /**
         * Server HTTP port.
         */
        private Integer port;
    
        /**
         * Network address to which the server should bind.
         */
        private InetAddress address;
      
        ... ... ...
      
    }
    

    其中,

    prefix = "server" 表示SpringBoot配置文件中的前缀,SpringBoot会将配置文件中以server开始的属性映射到该类的字段中。映射关系如下:

    五、SpringBoot的配置文件

    5.1 SpringBoot配置文件类型

    5.1.1 SpringBoot配置文件类型和作用

    SpringBoot是基于约定的,所以很多配置都有默认值,但如果想使用自己的配置替换默认配置的话,就可以使用application.properties或者application.yml(application.yaml)进行配置。

    SpringBoot默认会从Resources目录下加载application.properties或application.yml(application.yaml)文件

    其中,application.properties文件是键值对类型的文件,之前一直在使用,所以此处不在对properties文件的格式进行阐述。除了properties文件外,SpringBoot还可以使用yml文件进行配置,下面对yml文件进行讲解。

    5.1.2 application.yml配置文件

    5.1.2.1 yml配置文件简介

    YML文件格式是YAML (YAML Aint Markup Language)编写的文件格式,YAML是一种直观的能够被电脑识别的的数据数据序列化格式,并且容易被人类阅读,容易和脚本语言交互的,可以被支持YAML库的不同的编程语言程序导入,比如: C/C++, Ruby, Python, Java, Perl, C#, PHP等。YML文件是以数据为核心的,比传统的xml方式更加简洁。

    YML文件的扩展名可以使用.yml或者.yaml。

    5.1.2.2 yml配置文件的语法

    5.1.2.2.1 配置普通数据
    语法: key: value
    示例代码:
    name: haohao
    注意:value之前有一个空格
    
    5.1.2.2.2 配置对象数据
    语法:
    key:
    key1: value1
    key2: value2
    

    或者:

    key: {key1: value1,key2: value2}
    

    示例代码:

    person:
            name: haohao
            age: 31
            addr: beijing
          
          #或者
          
    person: {name: haohao,age: 31,addr: beijing}
    

    注意:key1前面的空格个数不限定,在yml语法中,相同缩进代表同一个级别

    5.1.2.2.2 配置Map数据

    同上面的对象写法

    5.1.2.2.3 配置数组(List、Set)数据

    语法:

    ​ key:
    
    ​ - value1
    
    ​ - value2
    

    或者:

    ​ key: [value1,value2]
    

    示例代码:

     city:
      - beijing
      - tianjin
      - shanghai
      - chongqing
      
    #或者
    
    city: [beijing,tianjin,shanghai,chongqing]
    
    #集合中的元素是对象形式
    student:
      - name: zhangsan
        age: 18
        score: 100
      - name: lisi
        age: 28
        score: 88
      - name: wangwu
        age: 38
        score: 90
    

    注意:value1与之间的 - 之间存在一个空格

    5.1.3 SpringBoot配置信息的查询

    上面提及过,SpringBoot的配置文件,主要的目的就是对配置信息进行修改的,但在配置时的key从哪里去查询呢?我们可以查阅SpringBoot的官方文档

    文档URL:https://docs.spring.io/spring-boot/docs/2.0.2.RELEASE/reference/htmlsingle/#common-application-properties

    常用的配置摘抄如下:

    # QUARTZ SCHEDULER (QuartzProperties)
    spring.quartz.jdbc.initialize-schema=embedded # Database schema initialization mode.
    spring.quartz.jdbc.schema=classpath:org/quartz/impl/jdbcjobstore/tables_@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
    spring.quartz.job-store-type=memory # Quartz job store type.
    spring.quartz.properties.*= # Additional Quartz Scheduler properties.
    
    # ----------------------------------------
    # WEB PROPERTIES
    # ----------------------------------------
    
    # EMBEDDED SERVER CONFIGURATION (ServerProperties)
    server.port=8080 # Server HTTP port.
    server.servlet.context-path= # Context path of the application.
    server.servlet.path=/ # Path of the main dispatcher servlet.
    
    # HTTP encoding (HttpEncodingProperties)
    spring.http.encoding.charset=UTF-8 # Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.
    
    # JACKSON (JacksonProperties)
    spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`.
    
    # SPRING MVC (WebMvcProperties)
    spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the dispatcher servlet.
    spring.mvc.static-path-pattern=/** # Path pattern used for static resources.
    spring.mvc.view.prefix= # Spring MVC view prefix.
    spring.mvc.view.suffix= # Spring MVC view suffix.
    
    # DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
    spring.datasource.driver-class-name= # Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
    spring.datasource.password= # Login password of the database.
    spring.datasource.url= # JDBC URL of the database.
    spring.datasource.username= # Login username of the database.
    
    # JEST (Elasticsearch HTTP client) (JestProperties)
    spring.elasticsearch.jest.password= # Login password.
    spring.elasticsearch.jest.proxy.host= # Proxy host the HTTP client should use.
    spring.elasticsearch.jest.proxy.port= # Proxy port the HTTP client should use.
    spring.elasticsearch.jest.read-timeout=3s # Read timeout.
    spring.elasticsearch.jest.username= # Login username.
    

    我们可以通过配置application.poperties 或者 application.yml 来修改SpringBoot的默认配置

    例如:

    application.properties文件

    server.port=8888
    server.servlet.context-path=demo
    application.yml文件
    
    server:
      port: 8888
      servlet:
        context-path: /demo
    

    5.2 配置文件与配置类的属性映射方式

    5.2.1 使用注解@Value映射

    我们可以通过@Value注解将配置文件中的值映射到一个Spring管理的Bean的字段上

    例如:

    application.properties配置如下:

    person:
      name: zhangsan
      age: 18
    

    或者,application.yml配置如下:

    person:
      name: zhangsan
      age: 18
    

    实体Bean代码如下:

    @Controller
    public class QuickStartController {
    
        @Value("${person.name}")
        private String name;
        @Value("${person.age}")
        private Integer age;
    
    
        @RequestMapping("/quick")
        @ResponseBody
        public String quick(){
            return "springboot 访问成功! name="+name+",age="+age;
        }
    
    }
    

    浏览器访问地址:http://localhost:8080/quick 结果如下:

    5.2.2 使用注解@ConfigurationProperties映射

    通过注解@ConfigurationProperties(prefix="配置文件中的key的前缀")可以将配置文件中的配置自动与实体进行映射

    application.properties配置如下:

    person:
      name: zhangsan
      age: 18
    

    或者,application.yml配置如下:

    person:
      name: zhangsan
      age: 18
    

    实体Bean代码如下:

    @Controller
    @ConfigurationProperties(prefix = "person")
    public class QuickStartController {
    
        private String name;
        private Integer age;
    
    
        @RequestMapping("/quick")
        @ResponseBody
        public String quick(){
            return "springboot 访问成功! name="+name+",age="+age;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public void setAge(Integer age) {
            this.age = age;
        }
    }
    

    浏览器访问地址:http://localhost:8080/quick 结果如下:

    注意:使用@ConfigurationProperties方式可以进行配置文件与实体字段的自动映射,但需要字段必须提供set方法才可以,而使用@Value注解修饰的字段不需要提供set方法

    六、SpringBoot整合其他技术

    6.1 SpringBoot整合Mybatis

    6.1.1 添加Mybatis的启动器

    <!--mybatis起步依赖-->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.1.1</version>
    </dependency>
    

    6.1.2 创建实体Bean

    public class User {
        // 主键
        private Long id;
        // 用户名
        private String username;
        // 密码
        private String password;
        // 姓名
        private String name;
      
        //此处省略getter和setter方法 .. ..
        
    }
    

    6.1.3 编写Mapper

    @Mapper
    public interface UserMapper {
        public List<User> queryUserList();
    }
    

    注意:@Mapper标记该类是一个mybatis的mapper接口,可以被spring boot自动扫描到spring上下文中

    6.1.4 配置Mapper映射文件

    在src\main\resources\mapper路径下加入UserMapper.xml配置文件"

    <?xml version="1.0" encoding="utf-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.test.mapper.UserMapper">
        <select id="queryUserList" resultType="user">
            select * from user
        </select>
    </mapper>
    

    6.1.5 在application.properties中添加mybatis的信息

    #spring集成Mybatis环境
    #pojo别名扫描包
    mybatis.type-aliases-package=com.test.domain
    #加载Mybatis映射文件
    mybatis.mapper-locations=classpath:mapper/*Mapper.xml
    

    6.1.6 编写测试Controller

    @Controller
    public class MapperController {
    
        @Autowired
        private UserMapper userMapper;
    
        @RequestMapping("/queryUser")
        @ResponseBody
        public List<User> queryUser(){
            List<User> users = userMapper.queryUserList();
            return users;
        }
    
    }
    

    6.1.7 测试

    6.1.8Mapper接口和映射文件在同一目录下

    此种情况下需要在maven的配置文件中添加如下信息:

    <build>
            <resources>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.properties</include>
                        <include>**/*.xml</include>
                    </includes>
                    <filtering>false</filtering>
                </resource>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                    <filtering>false</filtering>
                </resource>
            </resources>
        </build>
    

    并且无需在application.properties中配置mapper路径,只需要在引导类上添加@MapperScan注解即可

    @SpringBootApplication
    @MapperScan("com.test.mapper")
    public class Application1 {
    
        public static void main(String[] args) {
            SpringApplication.run(Application1.class, args);
        }
    }
    

    6.2 SpringBoot整合Junit

    6.2.1 添加Junit的启动器

    <!--测试的起步依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    

    6.2.2 编写测试类

    package com.test.test;
    
    import com.test.MySpringBootApplication;
    import com.test.domain.User;
    import com.test.mapper.UserMapper;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.List;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = MySpringBootApplication.class)
    public class MapperTest {
    
        @Autowired
        private UserMapper userMapper;
    
        @Test
        public void test() {
            List<User> users = userMapper.queryUserList();
            System.out.println(users);
        }
    
    }
    

    其中,

    SpringRunner继承自SpringJUnit4ClassRunner,使用哪一个Spring提供的测试测试引擎都可以

    public final class SpringRunner extends SpringJUnit4ClassRunner
    @SpringBootTest的属性指定的是引导类的字节码对象

    6.2.3 控制台打印信息

    相关文章

      网友评论

        本文标题:Spring Boot入门&整合常用框架整理丨深度好文

        本文链接:https://www.haomeiwen.com/subject/lrsbpctx.html