README.md

X-Boot

作者目前大四 能力经验有限 如有错误欢迎指正 期待您的捐赠支持！

宣传视频

• 作者亲自制作 点我观看

在线Demo

http://xboot.exrick.cn

前台为基于Vue+iView的独立项目请跳转至 x-boot-front 项目仓库查看

项目简介

• 代码拥有详细注释 学习与实战的不错选择
• 核心使用目前最新 SpringBoot 2.0.1.RELEASE
• JPA + Mybatis-Plus任意切换
  • 项目持久层默认推荐使用JPA，更简单易上手，且OOP首先应满足面向对象的要求，而不是面向数据库。复杂业务逻辑需联表查询时可选择Mybatis-Plus写sql
• AOP操作日志记录方式任意切换
  • 默认使用数据库记录记录，可配置切换使用Elasticseach记录，使用Spring-Data-Elasticsearch简化开发
• 极简代码生成
  • 只需输入实体类名即可生成三层代码，自动创建数据库表
• 为什么要前后端分离
  • 都什么时代了还在用JQuery？

分支说明

• master：基于Redis的‘JWT’ (待提交)
• jwt：基于JWT，由于刷新token机制较麻烦，作者不推荐(待提交)
• oauth2：基于OAuth2协议(待开发)

前端所用技术

• Vue 2.5.x、iView、iview-admin、iview-area、Vuex、Vue Router、ES6、webpack、axios、echarts、cookie等
• 前台为基于Vue+iView的独立项目请跳转至 x-boot-front 项目仓库查看

后端所用技术

各框架依赖版本皆使用目前最新版本

• Spring Boot 2.0.1.RELEASE
• SpringMVC
• Spring Security
• Spring Data JPA
• MyBatis-Plus
• Redis
• Elasticsearch：基于Lucene分布式搜索引擎
• Druid：阿里高性能数据库连接池
• Json Web Token(JWT)
• Beetl：模版引擎 代码生成使用
• Hutool：Java工具包
• Jasypt：配置文件加密(thymeleaf作者开发)
• Swagger2：Api文档生成
• MySQL
• Nginx
• Maven
• 第三方SDK
  • 七牛云文件存储服务
• 第三方接口
  • Mob全国天气预报接口：需注册账号创建应用后申请填入AppKey后免费使用
• 其它开发工具
  • Lombok
  • JRebel：开发热部署
  • 阿里JAVA开发规约插件

项目运行部署

• 安装依赖并启动：Redis、Elasticsearch(当配置使用ES记录日志时需要)
• Maven安装和在IDEA中配置
• 使用IDEA(破解/免费注册) 导入该Maven项目
• 修改配置文件 application.yml 相应配置，其中有详细注释
• MySQL数据库新建 xboot 数据库，配置文件已开启ddl自动生成表结构但无初始数据，请记得运行导入sql文件
• 配置第三方服务
  • Mob接口 现在需要注册申请后使用 在 cn.exrick.common.utils.IpInfoUtil 中修改填入你的AppKey
  • 七牛云对象存储 cn.exrick.common.utils.QiniuUtil 中修改填入你的配置
• 启动运行 XbootApplication.java 默认端口8888 访问接口文档 http://localhost:8888/swagger-ui.html 说明启动成功 管理员账密admin|123456
• 前台页面请启动基于Vue的 xboot-front 项目，并修改其接口代理配置

学习记录（更新中）

1.Spring Boot 2.x 区别总结

2.Spring Security整合JWT

3.Spring Security动态数据库权限管理

开发指南及相关技术栈说明

• 项目使用 Lombok 插件简化开发，请自行在编译器中安装，不安装会报错但不影响运行，常用注解说明：

  • @Data：自动生成get、set等方法
  • @Slf4j：日志打印可直接使用log.info()等

• 配置文件可使用Jasypt加密，可到 cn.exrick.xboot.common 包中找到 JasyptUtil 工具类生成加解密结果

# 配置文件加密key
jasypt:
  encryptor:
    password: xboot

spring:
  # 数据源
  datasource:
    # Jasypt加密 可到common-utils中找到JasyptUtil加解密工具类生成加密结果 格式为ENC(加密结果)
    password: ENC(F4B0s6u9xcDw3V+P0qC4CA==)

• 操作日志使用ES或数据库记录配置 注解使用 @SystemLog(description="操作日志名称")

xboot:
  # 日志记录方式 true使用Elasticsearch记录 false记录至数据库中
  logRecord:
    es: false

• 接口相关

  • 为方便前台配置代理，所有接口建议以统一路径例如“/xboot”开头
  • 登录成功后前台请在返回的result字段中保存token

  

  • 之后的请求中请在header或参数中添加该token即可

  

• 分布式限流(基于Redis令牌桶算法)

  • 全局限流

  xboot:
    # 全局限流
    rateLimit:
      enable: true
      # 每1秒内
      timeout: 1000
      # 总限制100个请求
      limit: 100

  • 指定方法限流注解

  @RateLimiter(limit = 1, timeout = 5000)

  • 支持多维度IP、uid等限流 详见代码

• 分布式同步锁(基于Redis)

    @Autowired
    private RedisDistributedLockTemplate lockTemplate;

    lockTemplate.execute("订单流水号", 5000, new Callback() {
        @Override
        public Object onGetLock() throws InterruptedException {
            //TODO 获得锁后要做的事
            log.info("生成订单流水号");
            return null;
        }
    
        @Override
        public Object onTimeout() throws InterruptedException {
            //TODO 获得锁超时后要做的事
            return null;
        }
    });

• 后台开发代码生成

  • 代码生成方法在 cn.exrick.xboot.generator 包中的 XbootGenerator.java 工具类，修改好生成类配置后运行主函数main方法即可生成三层相关代码，别忘了在实体类中添加相关字段，运行项目后将自动生成数据库表

• 增删改查(CRUD)

  • JPA与Mybatis-Plus随意切换

  • 不想写sql？Spring Data JPA 了解一下

    具体x-boot增删改文档示例

  • 复杂业务逻辑JPA联表太蛋疼？MyBatis-Plus 这就不用了解了吧

  • JPA与MybatisPlus同时使用时需注意实体类注解区别，更多请见官方文档，常用注解区别：

  //表名
  JPA: @Table(name = "t_user")
  MP:  @TableName("t_user")
  //排除非表字段
  JPA: @Transient
  MP:  @TableField(exist=false)

• Spring缓存注解

  @CacheConfig(cacheNames = "user")
  public interface UserService extends XbootBaseService<User,String> {
      @Cacheable(key = "#username")
      User findByUsername(String username);
  }

  • 删除刷新注解 @CacheEvict(key = "#u.username") 手动删除刷新缓存时注意key为：user::username

• Spring Security官方推荐权限管理：@PreAuthorize("hasRole('ADMIN')")

• Spring定时：@Scheduled(cron="cron表达式")

• Spring异步：@Async

等自行了解

作者其他项目推荐

• XMall：基于SOA架构的分布式电商购物商城

  

• 微信小程序APP

  • 捐赠≥19.9可加群私聊群主提前下载前台源码预览视频 赠送慕课网SpringCloud学习资源

  

技术疑问交流

• 给作者项目Star或捐赠后可加入交流群 475743731，还可免费获取 慕课网学习资源 和 UI框架
• 作者博客：http://blog.exrick.cn

捐赠