14 微服务电商【黑马乐优商城】：day01-springboot（理论篇）

时间  2019-11-09 标签 微服 黑马乐优商城 day01 day springboot 理论

 

本项目的笔记和资料的Download，请点击这一句话自行获取。css

day01-springboot（理论篇） ；day01-springboot（实践篇） ；day01-springboot（Thymeleaf快速入门）html

14 微服务电商【黑马乐优商城】：day01-springboot

 

 1.1.什么是SpringBoot

SpringBoot是Spring项目中的一个子工程，与咱们所熟知的Spring-framework 同属于spring的产品:java

> Takes an opinionated view of building production-ready Spring applications. Spring Boot favors convention over configuration and is designed to get you up and running as quickly as possible.mysql

翻译一下：web

> 用一些固定的方式来构建生产级别的spring应用。Spring Boot 推崇约定大于配置的方式以便于你可以尽量快速的启动并运行程序。redis

 

要先学完maven高级课程，理解子模块继承父工程的依赖原理。spring

2.2.1.添加父工程坐标

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

2.2.2.添加web启动器

为了让SpringBoot帮咱们完成各类自动配置，咱们必须引入SpringBoot提供的自动配置依赖，咱们称为启动器。由于咱们是web项目，这里咱们引入web启动器：sql

        <!--至关于springMVC的依赖坐标-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

须要注意的是，咱们并无在这里指定版本信息。由于SpringBoot的父工程已经对版本进行了管理了。mongodb

2.2.3.管理jdk版本

默认状况下，maven工程的jdk版本是1.5，而咱们开发使用的是1.8，所以这里咱们须要修改jdk版本，只须要简单的添加如下属性便可：数据库

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

下面会使用注解导入配置信息，建议使用下面的 springboot注解配置处理器

        <!--注解@ConfigurationProperties的提示处理器-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

2.3.启动类

Spring Boot项目经过main函数便可启动，咱们须要建立一个启动类：

而后编写main函数：

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

2.5.启动测试

运行main函数，查看控制台，能够看到监听的端口信息：

 

  • 1）监听的端口是8080
  • 2）SpringMVC的映射路径是：/
  • 3）/hello路径已经映射到了HelloController中的hello()方法

 

3.Java配置

使用spring boot开发项目 ，若是没有任何的xml，那么咱们若是要配置一个Bean该怎么办？好比咱们要配置一个数据库链接池，之前会这么玩：

<!-- 配置链接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
      init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />
</bean>

3.2.尝试java配置的@Value注解

java配置主要靠java类和一些注解，比较经常使用的注解有：

  • @Configuration：声明一个类做为配置类，代替xml文件
  • @Bean：声明在方法上，将方法的返回值加入Bean容器，代替<bean>标签
  • @value：属性注入
  • @PropertySource：指定外部属性文件

咱们接下来用java配置来尝试实现链接池配置：

首先引入Druid链接池依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.9</version>
</dependency>

建立一个jdbc.properties文件，编写jdbc属性：

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/leyou
jdbc.username=root
jdbc.password=root

而后编写代码：

@Configuration
@PropertySource("classpath:jdbc.properties")
public class JdbcConfig {

    @Value("${jdbc.url}")
    String url;
    @Value("${jdbc.driverClassName}")
    String driverClassName;
    @Value("${jdbc.username}")
    String username;
    @Value("${jdbc.password}")
    String password;

    @Bean public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(url);
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

 

解读：

  • @Configuration：声明咱们JdbcConfig是一个配置类
  • @PropertySource：指定属性文件的路径是:classpath:jdbc.properties
  • 经过@Value为属性注入值
  • 经过@Bean将 dataSource()方法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值加入Spring容器中。

而后咱们就能够在任意位置经过@Autowired注入DataSource了！

咱们在HelloController中测试：

@RestController
public class HelloController {

    @Autowired
    private DataSource dataSource;

    @GetMapping("hello")
    public String hello() {
        return "hello, spring boot!" + dataSource;
    }
}

而后Debug运行并查看，属性注入成功了。

@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。

3.3.SpringBoot的属性注入

在上面的案例中，咱们实验了java配置方式。不过属性注入使用的是@Value注解。这种方式虽然可行，可是不够强大，由于它只能注入基本类型值。

在SpringBoot中，提供了一种新的属性注入方式，支持各类java基本数据类型及复杂类型的注入。

1）咱们新建一个类，用来进行属性注入：

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
    private String url;
    private String driverClassName;
    private String username;
    private String password;
    // getters 和 setters方法
}

 

  • 在类上经过@ConfigurationProperties注解声明当前类为属性读取类

  • prefix="jdbc"读取属性文件中，前缀为jdbc的值。

  • 在类上定义各个属性，名称必须与属性文件中jdbc.后面部分一致

  • 须要注意的是，这里咱们并无指定属性文件的地址，因此咱们须要把jdbc.properties名称改成application.properties，这是SpringBoot默认读取的属性文件名：

 

#yml配置文件注释使用#
#数据库四项链接配置
jdbc:
  driver:com.mysql.cj.jdbc.Driver
  url:jdbc:mysql://localhost:3306/itheima?serverTimezone=Asia/Shanghai
  username:root
  password:root

 

2）在配置类JdbcConfig中使用这个属性：

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfig {

    @Bean public DataSource dataSource(JdbcProperties jdbc) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(jdbc.getUrl());
        dataSource.setDriverClassName(jdbc.getDriverClassName());
        dataSource.setUsername(jdbc.getUsername());
        dataSource.setPassword(jdbc.getPassword());
        return dataSource;
    }
}

 

  • 经过@EnableConfigurationProperties(JdbcProperties.class)来声明要使用JdbcProperties这个类的对象

  • 而后你能够经过如下方式注入JdbcProperties：

    • @Autowired注入

      @Autowired
private JdbcProperties prop;

       

    • 构造函数注入

      private JdbcProperties prop;
public JdbcConfig(Jdbcproperties prop){
    this.prop = prop;
}

       

    • 由@Bean声明的方法参数注入

      @Bean
public Datasource dataSource(JdbcProperties prop){
    // ...
}

       

本例中，咱们采用的是第三种方式。

 

3.四、更优雅的注入

事实上，若是一段属性只有一个Bean须要使用，咱们无需将其注入到一个类（JdbcProperties）中。而是直接在须要的地方声明便可：

@Configuration
public class JdbcConfig {

    @Bean
    // 声明要注入的属性前缀，SpringBoot会自动把相关属性经过检测到有的set方法注入到DataSource中
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}

咱们直接把@ConfigurationProperties(prefix = "jdbc")声明在须要使用的@Bean的方法上，而后SpringBoot就会自动调用这个Bean（此处是DataSource）的set方法，而后完成注入。使用的前提是：该类必须有对应属性的set方法！

 

4.自动配置原理

使用SpringBoot以后，一个整合了SpringMVC的WEB工程开发，变的无比简单，那些繁杂的配置都消失不见了，这是如何作到的？

一切魔力的开始，都是从咱们的main函数来的，因此咱们再次来看下启动类：

咱们发现特别的地方有两个：

  • 注解：@SpringBootApplication
  • run方法：SpringApplication.run()

咱们分别来研究这两个部分。

4.1.了解@SpringBootApplication

点击进入，查看源码：

这里重点的注解有3个：

  • @SpringBootConfiguration
  • @EnableAutoConfiguration
  • @ComponentScan

4.1.1.@SpringBootConfiguration

咱们继续点击查看源码：

经过这段咱们能够看出，在这个注解上面，又有一个@Configuration注解。经过上面的注释阅读咱们知道：这个注解的做用就是声明当前类是一个配置类，而后Spring会自动扫描到添加了@Configuration的类，而且读取其中的配置信息。而@SpringBootConfiguration是来声明当前类是SpringBoot应用的配置类，项目中只能有一个。因此通常咱们无需本身添加。

4.1.2.@EnableAutoConfiguration

关于这个注解，官网上有一段说明：

The second class-level annotation is @EnableAutoConfiguration. This annotation tells Spring Boot to “guess” how you want to configure Spring, based on the jar dependencies that you have added. Since spring-boot-starter-web added Tomcat and Spring MVC, the auto-configuration assumes that you are developing a web application and sets up Spring accordingly.

简单翻译如下：

第二级的注解@EnableAutoConfiguration，告诉SpringBoot基于你所添加的依赖，去“猜想”你想要如何配置Spring。好比咱们引入了spring-boot-starter-web，而这个启动器中帮咱们添加了tomcat、SpringMVC的依赖。此时自动配置就知道你是要开发一个web应用，因此就帮你完成了web及SpringMVC的默认配置了！

总结，SpringBoot内部对大量的第三方库或Spring内部库进行了默认配置，这些配置是否生效，取决于咱们是否引入了对应库所需的依赖，若是有那么默认配置就会生效。

因此，咱们使用SpringBoot构建一个项目，只须要引入所需框架的依赖，配置就能够交给SpringBoot处理了。除非你不但愿使用SpringBoot的默认配置，它也提供了自定义配置的入口。

4.1.3.@ComponentScan

咱们跟进源码：

 并无看到什么特殊的地方。咱们查看注释：

大概的意思：

配置组件扫描的指令。提供了相似与<context:component-scan>标签的做用

经过basePackageClasses或者basePackages属性来指定要扫描的包。若是没有指定这些属性，那么将从声明这个注解的类所在的包开始，扫描包及子包

而咱们的@SpringBootApplication注解声明的类就是main函数所在的启动类，所以扫描的包是该类所在包及其子包。所以，通常启动类会放在一个比较前的包目录中。

4.2.默认配置原理

4.2.1默认配置类

经过刚才的学习，咱们知道@EnableAutoConfiguration会开启SpringBoot的自动配置，而且根据你引入的依赖来生效对应的默认配置。那么问题来了：

  • 这些默认配置是在哪里定义的呢？
  • 为什么依赖引入就会触发配置呢？

其实在咱们的项目中，已经引入了一个依赖：spring-boot-autoconfigure，其中定义了大量自动配置类：

 还有：

很是多，几乎涵盖了如今主流的开源框架，例如：

  • redis
  • jdbc
  • jackson
  • mongodb
  • jpa
  • solr
  • elasticsearch
  • ……

咱们来看一个咱们熟悉的，例如SpringMVC，查看mvc 的自动配置类：

 打开WebMvcAutoConfiguration：

咱们看到这个类上的4个注解：

  • @Configuration：声明这个类是一个配置类

  • @ConditionalOnWebApplication(type = Type.SERVLET)

    ConditionalOn，翻译就是在某个条件下，此处就是知足项目的类是是Type.SERVLET类型，也就是一个普通web工程，显然咱们就是

  • @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })

    这里的条件是OnClass，也就是知足如下类存在：Servlet、DispatcherServlet、WebMvcConfigurer，其中Servlet只要引入了tomcat依赖天然会有，后两个须要引入SpringMVC才会有。这里就是判断你是否引入了相关依赖，引入依赖后该条件成立，当前类的配置才会生效！

  • @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)

    这个条件与上面不一样，OnMissingBean，是说环境中没有指定的Bean这个才生效。其实这就是自定义配置的入口，也就是说，若是咱们本身配置了一个WebMVCConfigurationSupport的类，那么这个默认配置就会失效！

接着，咱们查看该类中定义了什么：

视图解析器：

 处理器适配器（HandlerAdapter）：

4.2.2.默认配置属性

另外，这些默认配置的属性来自哪里呢？

 

 咱们看到，这里经过@EnableAutoConfiguration注解引入了两个属性：WebMvcProperties和ResourceProperties。

 咱们查看这两个属性类：

 一、找到了内部资源视图解析器的prefix和suffix属性。

 

二、ResourceProperties中主要定义了静态资源（.js,.html,.css等)的路径：

 若是咱们要覆盖这些默认属性，只须要在application.properties中定义与其前缀prefix和字段名一致的属性便可。

 

 application*.yml  配置文件格式使用可参考：

 黑马_13 Spring Boot：04.spring boot 配置文件

 实际运行spring boot开发的项目，取上述两个配置文件的并集，而且以 application*.properties定义的优先级更高。

4.3.总结

SpringBoot为咱们提供了默认配置，而默认配置生效的条件通常有两个：

  • 你引入了相关依赖
  • 你本身没有配置

1）启动器

因此，咱们若是不想配置，只须要引入依赖便可，而依赖版本咱们也不用操心，由于只要引入了SpringBoot提供的stater（启动器），就会自动管理依赖及版本了。

所以，玩SpringBoot的第一件事情，就是找启动器，SpringBoot提供了大量的默认启动器，参考课前资料中提供的《SpringBoot启动器.txt》

2）全局配置

另外，SpringBoot的默认配置，都会读取默认属性，而这些属性能够经过自定义application.properties文件来进行覆盖。这样虽然使用的仍是默认配置，可是配置中的值改为了咱们自定义的。

所以，玩SpringBoot的第二件事情，就是经过application.yml来覆盖默认属性值，造成自定义配置。咱们须要知道SpringBoot的默认属性key，很是多，参考课前资料的：《SpringBoot全局属性.md》

5.SpringBoot实践

接下来，咱们来看看如何用SpringBoot来玩转之前的SSM,咱们沿用以前讲解SSM用到的数据库tb_user和实体类User

day01springboot 5.4实践整合mybatis（实战篇）代码和内容

请点击上面的超连接，跳转到个人CSDN博客，若有疑问请在CSDN评论区留言。

5.1.1.修改端口 

#tomcat服务器映射端口
server:
 port: 8080
 servlet:
   #对应于视图层Controller类中的@RequestMapping的("/*.do")
   path: "*.do"

上面的配置信息至关于SSM整合Web项目中WEB-INF目录中的web.xml

5.1.2.访问静态资源

如今，咱们的项目是一个jar工程，那么就没有webapp，咱们的静态资源该放哪里呢？

回顾咱们上面看的源码，有一个叫作ResourceProperties的类，里面就定义了静态资源的默认查找路径：

 

默认的静态资源路径为：

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

只要静态资源放在这些目录中任何一个，SpringMVC都会帮咱们处理。

咱们习惯会把SpringBoot静态资源放在classpath:/static/目录下。咱们建立目录，而且添加一些静态资源：

 

5.1.3.添加拦截器

拦截器也是咱们常常须要使用的，在SpringBoot中该如何配置呢？

拦截器不是一个普通属性，而是一个Java类，因此就要用到上面讲过的java配置方式。在SpringBoot官方文档中有这么一段说明：

若是你想要保持Spring Boot的一些默认MVC特征，同时又想自定义一些MVC配置（包括：拦截器，格式化器, 视图控制器、消息转换器 等等），你应该让一个类实现WebMvcConfigurer，而且添加@Configuration注解，可是千万不要加@EnableWebMvc解。若是你想要自定义HandlerMapping、HandlerAdapter、ExceptionResolver等组件，你能够建立一个WebMvcRegistrationsAdapter实例 来提供以上组件。

若是你想要彻底自定义SpringMVC，不保留SpringBoot提供的一切特征，你能够本身定义类而且添加@Configuration注解和@EnableWebMvc注解。

package cn.bjut.interceptor;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

// 自定义拦截器XXXInterceptor implements HandlerInterceptor{}
public class LoginInterceptor implements HandlerInterceptor {
    //工厂模式得到一个Logger实例对象
    private Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        logger.debug("preHandle method is now running!");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        logger.debug("postHandle method is now running!");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        logger.debug("afterCompletion method is now running!");
    }
}
LoginInterceptor implements HandlerInterceptor

而后，咱们用定义配置类，注册拦截器： 

package cn.bjut.config;

import cn.bjut.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration public class MvcConfigurer implements WebMvcConfigurer {
    /**
     * 经过@Bean注解，将咱们定义的拦截器注册到Spring容器
     * @return
     */
    @Bean
    public LoginInterceptor loginInterceptor(){
        return new LoginInterceptor();
    }

    /**
     * 重写接口中的addInterceptors方法，添加自定义拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 经过registry来注册拦截器，经过addPathPatterns来添加拦截路径
        registry.addInterceptor(this.loginInterceptor()).addPathPatterns("/**");
    }
}

 接下来运行并查看日志：

 你会发现日志中什么都没有，由于咱们记录的log4j级别是debug，默认是显示info级，咱们须要进行配置。

 application.properties

# 设置com.leyou包的日志级别为debug
logging.level.com.leyou=debug

 application.yml

#log4j日志输出控制
logging:
 level:
  cn.bjut.interceptor: debug

 

5.2.整合jdbc和事务

spring中的jdbc链接和事务是配置中的重要一环，在SpringBoot中该如何处理呢？

答案是不须要特殊处理，咱们只要找到SpringBoot提供的启动器便可。

固然，不要忘了数据库驱动，SpringBoot并不知道咱们用的什么数据库。

        <!-- springboot整合JDBC事务并包含HikariCP链接池的启动器-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>

        <!-- MySQL数据库链接驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.17</version>
            <scope>runtime</scope>
        </dependency>

SpringBoot中经过注解来控制事务，就是咱们熟知的 @Transactional

 

================================================

参考资料：

14 微服务电商【乐优商城】：day01-springboot（实践篇）

14 微服务电商【黑马乐优商城】：day01-springboot（Thymeleaf快速入门）

学习Spring Boot：（十五）使用Lombok来优雅的编码

lombok踩坑与思考

end

联系我们 沪ICP备13005482号-10