易水公共组件入门教程

在日常开发过程中，发现有一个重要的功能会被经常使用到，但是又没有一个比较好用的功能集合，在开发项目是需要反复配置，造成了大量不必要的重复性简单劳动，因此对日常使用到功能进行了一个通用封装，形成了【易水风萧通用组件】(以后简称组件)，方便后期项目开发。 本着"一次开发,开箱即用"的原则，组件在开发时遵守以下几点：

• 开箱即用
• 基本配置,即在开启本组件功能后，无须二次配置即能使用组件的基本工功能。
• 个性配置，组件提供大量的配置属性，能通过预留的配置属性自定义组件功能。
• 高级配置，在系统默认配置和个性配置不能满足开发需要时，能通过自定义组件中的某些元件实现高级配置。

#核心功能

易水风萧通用组件主要包含以下一些常用功能：

• swagger-ui文档
• 全局跨域支持
• 全局异常捕获
• 通用辅助工具
• 验证码功能
• spring security
• oauth2
• 第三方登陆(QQ登陆、微信登陆)

在使用 易水风萧通用组件 之前，需要先在项目的pom依赖里加入以下配置：

<dependency>
    <groupId>com.yishuifengxiao.common</groupId>
    <artifactId>common-spring-boot-starter</artifactId>
    <version>最新的版本号</version>
</dependency>

注意：在使用时请参考 https://mvnrepository.com/artifact/com.yishuifengxiao.common/common-spring-boot-starter 将版本号替换为最新版本。

更多软件特性及使用说明请参见：

官方文档 http://doc.yishuifengxiao.com/start.html

源码地址 https://gitee.com/zhiyubujian/common-starter

本文档针对于4.0.0及后续版本，由于3.0.0版本更新内容较多，对于历史版本本说明文档可能会有较大出入。