品达通用权限系统-Day01

1. 项目概述

1.1 项目介绍

对于企业中的项目绝大多数都需要进行用户权限管理、认证、鉴权、加密、解密、XSS防跨站攻击等。这些功能整体实现思路基本一致，但是大部分项目都需要实现一次，这无形中就形成了巨大的资源浪费。本项目就是针对这个问题，提供了一套通用的权限解决方案----品达通用权限系统。

品达通用权限系统基于SpringCloud(Hoxton.SR1) +SpringBoot(2.2.2.RELEASE) 的微服务框架，具备通用的用户管理、资源权限管理、网关统一鉴权、XSS防跨站攻击等多个模块，支持多业务系统并行开发，支持多服务并行开发，可以作为后端服务的开发脚手架。核心技术采用SpringBoot、Zuul、Nacos、Fegin、Ribbon、Hystrix、JWT Token、Mybatis Plus等主要框架和中间件。

本项目具有两个主要功能特性：

序号	功能特性	说明	备注
1	用户权限管理	具有用户、部门、岗位、角色、菜单管理，并通过网关进行统一的权限认证
2	微服务开发框架	本项目同时也是一个微服务开发框架，集成了基础的公共组件，包括数据库、 缓存、日志、表单验证、对象转换、防注入和接口文档管理等工具。

1.2 业务架构

序号	业务分层	详情	备注
1	前端	PC端、移动端
2	Web服务器
3	网关层
4	应用层	用户功能、部分功能、权限功能、菜单功能、角色功能等
5	服务层	用户服务、部分服务、权限服务、菜单服务、角色服务等
6	底层	缓存服务、数据持久化
7	支撑层	配置中心、注册中心、组件私服、代码库、持续集成工具

1.3 技术架构

序号	技术分层	详情	备注
1	前端	JavaScript、CSS、Node.js、Vue
2	Web服务器	WAF防火墙、DNS域名解析、Nginx反向代理
3	网关层	Zuul、Nginx、Cors、Filter
4	服务层	Springboot、Feign、Rabbion、Easy-captcha； SpringCloud、Druid、undertow、hibernate validatort； Mybatis plus、j2cache、Jjwt、sel4j/logback； hutool、p6spy、lombok、Swagger2/knife4j
5	存储层	Redis cluster、MySQL Cluster、Nacos（配置中心、注册中心）
6	支撑层	Maven、Nexus、GitLab、Jenkins

1.4 环境要求

序号	组件	版本	下载地址	备注
1	JDK	1.8+
2	Maven	3.3 +	http://maven.apache.org/download.cgi
3	Mysql	5.6.0 +	https://downloads.mysql.com/archives/community
4	Redis	4.0 +	https://redis.io/download
5	Nacos	1.1.4	https://github.com/alibaba/nacos/releases
6	Node	11.3+（集成npm）	https://nodejs.org/en/download

2. Spring Boot starter

我们知道Spring Boot大大简化了项目初始搭建以及开发过程，而这些都是通过Spring Boot提供的starter来完成的。品达通用权限系统就是基于Spring Boot进行开发，而且一些基础模块其本质就是starter，所以我们需要对Spring Boot的starter有一个全面深入的了解，这是我们开发品达通用权限系统的必备知识。

2.1 starter介绍

spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。

Spring官方提供了很多starter，第三方也可以定义starter。为了加以区分，starter从名称上进行了如下规范：

• Spring官方提供的starter名称为：spring-boot-starter-xxx； 例如：Spring官方提供的spring-boot-starter-web
• 第三方提供的starter名称为：xxx-spring-boot-starter；例如：由mybatis提供的mybatis-spring-boot-starter

2.2 starter原理

Spring Boot之所以能够帮我们简化项目的搭建和开发过程，主要是基于它提供的起步依赖和自动配置。

2.2.1 起步依赖

起步依赖，其实就是将具备某种功能的坐标打包到一起，可以简化依赖导入的过程。例如，我们导入spring-boot-starter-web这个starter，则和web开发相关的jar包都一起导入到项目中了。如下图所示：

2.2.2 自动配置

自动配置，就是无须手动配置xml，自动配置并管理bean，可以简化开发过程。那么Spring Boot是如何完成自动配置的呢？

自动配置涉及到如下几个关键步骤：

1. 基于Java代码的Bean配置
2. 自动配置条件依赖
3. Bean参数获取
4. Bean的发现
5. Bean的加载

我们可以通过一个实际的例子mybatis-spring-boot-starter来说明自动配置的实现过程。

2.2.2.1 基于Java代码的Bean配置

当我们在项目中导入了mybatis-spring-boot-starter这个jar后，可以看到它包括了很多相关的jar包，如下图：

其中在mybatis-spring-boot-autoconfigure这个jar包中有如下一个MybatisAutoConfiguration自动配置类：

打开这个类，截取的关键代码如下：

1. @Configuration和**@Bean**这两个注解一起使用就可以创建一个基于java代码的配置类，可以用来替代传统的xml配置文件。
2. @Configuration 注解的类可以看作是能生产让Spring IoC容器管理的Bean实例的工厂。
3. @Bean 注解的方法返回的对象可以被注册到spring容器中。

所以上面的MybatisAutoConfiguration这个类，自动帮我们生成了SqlSessionFactory和SqlSessionTemplate这些Mybatis的重要实例并交给spring容器管理，从而完成bean的自动注册。

2.2.2.2 自动配置条件依赖

从MybatisAutoConfiguration这个类中使用的注解可以看出，要完成自动配置是有依赖条件的。

所以要完成Mybatis的自动配置，需要在类路径中存在SqlSessionFactory.class、SqlSessionFactoryBean.class这两个类，同时需要存在DataSource这个bean且这个bean完成自动注册。

这些注解是spring boot特有的，常见的条件依赖注解有：

序号	注解	功能说明
1	@ConditionalOnBean	仅在当前上下文中存在某个bean时，才会实例化这个Bean
2	@ConditionalOnClass	某个class位于类路径上，才会实例化这个Bean
3	@ConditionalOnExpression	当表达式为true的时候，才会实例化这个Bean
4	@ConditionalOnMissingBean	仅在当前上下文中不存在某个bean时，才会实例化这个Bean
5	@ConditionalOnMissingClass	某个class在类路径上不存在的时候，才会实例化这个Bean
6	@ConditionalOnNotWebApplication	不是web应用时才会实例化这个Bean
7	@AutoConfigureAfter	在某个bean完成自动配置后实例化这个bean
8	@AutoConfigureBefore	在某个bean完成自动配置前实例化这个bean

2.2.2.3 Bean参数获取

要完成mybatis的自动配置，需要我们在配置文件中提供数据源相关的配置参数，例如数据库驱动、连接url、数据库用户名、密码等。那么spring boot是如何读取yml或者properites配置文件的的属性来创建数据源对象的？

在我们导入mybatis-spring-boot-starter这个jar包后会传递过来一个spring-boot-autoconfigure包，在这个包中有一个自动配置类DataSourceAutoConfiguration，如下所示：

我们可以看到这个类上加入了EnableConfigurationProperties这个注解，继续跟踪源码到DataSourceProperties这个类，如下：

可以看到这个类上加入了ConfigurationProperties注解，这个注解的作用就是把yml或者properties配置文件中的配置参数信息封装到ConfigurationProperties注解标注的bean(即DataSourceProperties)的相应属性上。

@EnableConfigurationProperties注解的作用是使@ConfigurationProperties注解生效。

2.2.2.4 Bean的发现

spring boot默认扫描启动类所在的包下的主类与子类的所有组件，但并没有包括依赖包中的类，那么依赖包中的bean是如何被发现和加载的？

我们需要从Spring Boot项目的启动类开始跟踪，在启动类上我们一般会加入SpringBootApplication注解，此注解的源码如下：

重点介绍如下三个注解：

1. SpringBootConfiguration：作用就相当于Configuration注解，被注解的类将成为一个bean配置类
2. ComponentScan：作用就是自动扫描并加载符合条件的组件，最终将这些bean加载到spring容器中
3. EnableAutoConfiguration ：这个注解很重要，借助@Import的支持，收集和注册依赖包中相关的bean定义

继续跟踪EnableAutoConfiguration注解源码：

@EnableAutoConfiguration注解引入了@Import这个注解。

Import：导入需要自动配置的组件，此处为EnableAutoConfigurationImportSelector这个类

EnableAutoConfigurationImportSelector类源码如下：

EnableAutoConfigurationImportSelector继承了AutoConfigurationImportSelector类，继续跟踪AutoConfigurationImportSelector类源码：

AutoConfigurationImportSelector类的getCandidateConfigurations方法中的调用了SpringFactoriesLoader类的loadFactoryNames方法，继续跟踪源码：

SpringFactoriesLoader的loadFactoryNames静态方法可以从所有的jar包中读取META-INF/spring.factories文件，而自动配置的类就在这个文件中进行配置：

spring.factories文件内容如下：

这样Spring Boot就可以加载到MybatisAutoConfiguration这个配置类了。

2.2.2.5 Bean的加载

在Spring Boot应用中要让一个普通类交给Spring容器管理，通常有以下方法：
1. 使用 @Configuration与@Bean 注解
2. 使用 @Controller @Service @Repository @Component 注解标注该类并且启用@ComponentScan自动扫描
3. 使用 @Import 方法

其中Spring Boot实现自动配置使用的是@Import注解这种方式，AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名，这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。

2.2.3 自动配置总结

我们可以将自动配置的关键几步以及相应的注解总结如下：

1、@Configuration与@Bean：基于Java代码的bean配置

2、@Conditional：设置自动配置条件依赖

3、@EnableConfigurationProperties与@ConfigurationProperties：读取配置文件转换为bean

4、@EnableAutoConfiguration与@Import：实现bean发现与加载

Day01 结束, 后续…