AI 助理
备案控制台
开发者社区 数据库 文章 正文

SpringBoot整合jwt和mybatis-plus的脚手架项目

2019-09-27 2263
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云数据库 Tair（兼容Redis），内存型 2GB
推荐场景：
通过缓存加速数据库访问
Redis 开源版，标准版 2GB
推荐场景：
搭建游戏排行榜
简介： 近期给公司弄了个脚手架项目，打算以后后台开发就用这个了，希望留下您宝贵的建议，同时求star~点击跳转到github地址概述Volcano是一个基于springboot后台开发简易脚手架。能实现当作一个单独项目或者作为微服务的一个节点进行快速开发和部署。

近期给公司弄了个脚手架项目，打算以后后台开发就用这个了，希望留下您宝贵的建议，同时求star~

点击跳转到github地址

概述
Volcano是一个基于springboot后台开发简易脚手架。能实现当作一个单独项目或者作为微服务的一个节点进行快速开发和部署。

概述

Volcano是一个基于springboot后台开发简易脚手架。能实现当作一个单独项目或者作为微服务的一个节点进行快速开发和部署。

项目结构

javasea-volcano 父项目, 用于springcloud和springboot的版本管控, maven插件, 仓库统一管控等.

|--javasea-volcano-base: 测试类和相关业务配置， 依赖common项目中的组件，开发的时候在该项目的基础上添 加添加业务代码即可。

|--javasea-volcano-common:常用组件和工具类

项目环境

中间件 版本 备注
JDK 1.8+ JDK1.8及以上
MySQL 5.6+ 5.6及以上
Redis 3.2+

基本功能

参考包com.zhirui.lmwy.wms.demo下的配置

参数校验

JSR校验

spring-boot-starter-web已经默认集成了JSR303校验，只需要直接使用注解校验即可。

参考测试类： com.zhirui.lmwy.wms.demo.web.controller.TestCheckParamController

手动校验

Assert类定义了不满足条件后快速断言的方式，可以在校验参数中使用。

还可以采用Spring的Assert进行校验

//第一个参数为false则抛出IllegalArgumentException异常
Assert.isTrue(concurrentConsumers > 0, "'concurrentConsumers' value must be at least 1 (one)");
Assert.isTrue(!this.exclusive || concurrentConsumers == 1,"When the consumer is exclusive, the concurrency must be 1");

也可以采用Optional进行校验

ZOrder order = this.getOrderByOrderNum(orderNum);
Optional.ofNullable(order).filter(o -> {
    return null != o && (0 == o.getStatus() || 3 == o.getStatus() || 9 == o.getStatus());
}).orElseThrow(() -> new ParamException("获取数据异常,订单号有误或者订单状态异常!"));

还可以通过guava的Preconditions类来进行参数检查。有需要请自行百度。

参数转换

参考测试类：TestDateConverterAndJson

URL方式传值到后端转换

URL传参到后端包括 如下三种方式传参：

@GetMapping("testDateConverter")
public Student testDateConverter(@RequestParam Student student){...}

@GetMapping("testDateConverter")
public Student testDateConverter(Student student){...}

@GetMapping("testDateConverter/{id}")
public Student testDateConverter(@PathVariable Integer id){...}

com.zhirui.lmwy.common.converter包下定义了很多转换类：

  • StringToDateConverter

如果实体属性是Date，通过该转换器将String转Date类型。效果和日期属性上的注解@DatetimeFormat相同。但是启用该转换器的时候，实体属性上的注解@DatetimeFormat不再生效。

  • StringToDoubleConverter

如果实体属性是Double，通过该转换器将String转Double类型。

  • StringToIntegerConverter

如果实体属性是Integer，通过该转换器将String转Integer类型。

请求体方式传值到后端转换

请求体方式传参到后端 包括如下方式：

@PostMapping("testDateConverter2")
public Student testDateConverter2(@RequestBody Student student){...}

com.zhirui.lmwy.common.json.jackson包下定义了JSON的序列化和反序列化方式：

  • deserializer 包下的序列化类

在@RequestBody接参时候，会调用该包中的序列化类将JSON转换成实体接参。

  • serializer 包下的序列化类

用于后端传值给前端。

后端传值给前端

com.zhirui.lmwy.common.json.jackson.serializer包下的定义了序列化类 。

在Controller类上添加注解@ResponseBody或者@RestController，那么后端传值给前端是JSON方式。

如果是返回值是对象或者集合，会用序列化类进行参数类型转换。

如下列子中，Student中的两个属性日期会转换成serializer 定义的格式“yyyy-MM-dd HH:mm:ss”。

序列化类`JacksonDateSerializer的作用相当于在属性上添加了@JsonFormat(pattern="yyyy-MM-dd")，实现将Date类型转换成String，但是添加JacksonDateSerializer后 @JsonFormat(pattern="yyyy-MM-dd")`失效。

    @PostMapping("testDateConverter2")
    public Student testDateConverter2(@RequestBody Student student){
        System.out.println(student);
        Student s = new Student();
        s.setBirth(new Date());
        s.setCreateTime(LocalDateTime.now());
        return s;
    }

异常处理

在com.zhirui.lmwy.common.exception.impl中定义了三大类异常：

BusinessException： 通用业务异常
ParamException：参数校验异常
AuthenticationException：认证失败异常

Exceptions类定义了快捷抛出异常的一些通用方法，在需要抛出异常时请不要去throw new XXXException()，而是用Exceptions类的方法进行操作。

已经定义了全局异常处理器GlobalExceptionHandler对各种异常可以进行处理，请不要在controller和service中try..catch。

返回值处理

controller的返回前端使用ResultModel类进行封装，里面有code，msg，data等字段。

各种场景下的ResultModel返回：

    //插入后返回方式， msg：插入成功；插入失败
    public ResultModel resultInsert(){
        boolean flag = false;
        return ResultModel.resultInsert(flag);
    }

    //更新后返回方式， msg：更新成功；更新失败
    public ResultModel resultUpdate(){
        boolean flag = false;
        return ResultModel.resultUpdate(flag);
    }

    //删除后返回方式， msg：删除成功；删除失败
    public ResultModel resultDelete(){
        boolean flag = false;
        return ResultModel.resultDelete(flag);
    }

    //删除后返回方式， msg：操作成功；操作失败
    public ResultModel result(){
        boolean flag = false;
        return ResultModel.result(flag);
    }

    //认证失败返回方式， msg：认证信息异常
    public ResultModel errorTokenMsg(){
        boolean flag = false;
        //如果msg参数为null，那么是默认的msg：认证信息异常
        return ResultModel.errorTokenMsg(null);
    }

推荐优先上面的放回方式，如果不能满足，还可以使用如下通用的失败、成功的返回方式：

ResultModel.error();  //失败返回方式
ResultModel.ok();       //成功返回方式

AOP 日志输出

  1. 添加坐标
<!-- AOP -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- console彩色日志 -->
<dependency>
    <groupId>org.fusesource.jansi</groupId>
    <artifactId>jansi</artifactId>
    <version>1.18</version>
</dependency>
  1. 定义AOP类实现彩色日志输出

参考：com.zhirui.lmwy.common.aop.LogAop

集成 丝袜哥

在common项目中集成了swagger

  1. pom中添加注解
        <!-- swagger start -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- swagger end -->
  1. 添加配置

两个配置类：

com.zhirui.lmwy.common.swagger.SwaggerConfiguration

com.zhirui.lmwy.common.swagger.SwaggerProperties

  1. 设置自定义显示参数

在base项目的application.yaml中添加如下配置进行设置：

swagger:
  #  open: true              #是否开启swagger,在生产环境下需要关闭
  protocol: http          #协议，http或https
  base-package: com.zhirui.lmwy.wms   #一定要写对，会在这个路径下扫描controller定义
  title: volcano-base项目
  version: 1.0
  description: volcano-base项目丝袜哥测试
  1. 在controller和model中使用swagger

controller类中使用参考：com.zhirui.lmwy.wms.demo.web.controller.TestCurdController

model类中使用参考：com.zhirui.lmwy.wms.demo.web.entity.User

  1. 通过swagger进行http请求

    丝袜哥默认的访问方式

    通过controller 重定向后的访问方式

集成 mybatis-plus（下文中称为MP）

ORM框架使用mybatis-plus，简便了CURD操作

  1. 添加pom

            <!-- mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency>
        <!-- 代码生成器  start -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.2.0</version>
        </dependency>
        <!-- 代码生成器需要的引擎模板 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
        <!-- 代码生成器  end -->

  2. 在yml中进行配置

    mybatis-plus:
  mapper-locations: classpath:mapper/**/*.xml
  global-config:
    db-config:
      id-type: AUTO  #主键自增长
  3. 添加配置类配置

下列代码中使用了租户模式，如果只是单纯需要添加分页插件，只需要如下方式即可：

@Bean
public PaginationInterceptor paginationInterceptor() {
 PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
 return paginationInterceptor;
}

/** 分页插件: 实现物理分页 */
@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    ArrayList<ISqlParser> iSqlParsers = new ArrayList<>();
    TenantSqlParser tenantSqlParser = new TenantSqlParser();
    tenantSqlParser.setTenantHandler(new TenantHandler() {
        @Override
        public Expression getTenantId(boolean where) {
            return new StringValue(tenantId);
        }

        @Override
        public String getTenantIdColumn() {
            //指定表中的租户列
            return "tenant_id";
        }
        @Override
        public boolean doTableFilter(String tableName) {
            return false;
        }
    });
    iSqlParsers.add(tenantSqlParser);
    paginationInterceptor.setSqlParserList(iSqlParsers);
    return paginationInterceptor;
}

通过MP进行CRUD操作

参考测试类和官网：com.zhirui.lmwy.wms.demo.web.controller.TestCurdController

代码生成器

采用了MP的代码生成器，实现了两个代码生成器。

在javasea-volcano-base项目的src/test/java目录的 com.zhirui.lmwy.wms包下，按照注释修改为自己需要的配置运行即可。看个人习惯，推荐用PrimaryCodeGenerator 。

  • SencondCodeGenerator

通过数据库表生成基本的entity，mapper，controller和service类等基本类。

  • PrimaryCodeGenerator

在 SencondCodeGenerator 功能的基础上，controller，entity中生成swagger的注解。controller、service生成常用的crud方法。

集成redis

  1. 添加pom坐标
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
  1. yml中进行配置
spring:
    redis:
      host: 127.0.0.1
      port: 6379
      password: zhirui888
      timeout: 2000
      database: 6
      lettuce:
        pool:
          max-active: 8
          max-wait: 1
          max-idle: 8
          min-idle: 0

  1. 配置类中进行配置

    • 定义redis的RedisTemplate

    详见：com.zhirui.lmwy.common.redis.RedisTemplateConfig

    • 开启springcache

    详见：com.zhirui.lmwy.common.redis.RedisCacheConfig

    • redis工具类

    详见：com.zhirui.lmwy.common.redis.RedisUtils

集成 JWT

添加jwt坐标

<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.1</version>
    <scope>compile</scope>
</dependency>

yml中配置jwt

custom:
    jwt:
      header: token
      secret: 666666          #密码，用于生成签名
      issuer: volcano         #签发人
      subject: volcano-jwt    #主题
      audience: web           #签发的目标
      expire-minutes: 20      #过期时间
    interceptor:
      jwt:
        exclude:
          path: /swagger-resources/**,/api-docs/**,/v2/api-docs/**,/login,/verificationCode,/doc/**,/error/**,/docs,/test/**
      permission:
        exclude:
          path: /swagger-resources/**,/api-docs/**,/v2/api-docs/**,/adminLogin,/sysLogin,/login.html,/verificationCode,/doc/**,/error/**,/docs
      token-timeout:
        exclude:
          path: /swagger-resources/**,/api-docs/**,/v2/api-docs/**,/docs

添加登陆接口

登陆后会将token信息保存到redis

详见登陆controller：com.zhirui.lmwy.wms.security.controller.LoginController

添加jwt拦截器

拦截到请求后会进行校验，校验方式如下：

// 验证token是否有效
Jws<Claims> jws = JwtUtil.verify(token);

token未过期且合法的才能校验通过，否则抛出401异常。

详见jwt拦截器：com.zhirui.lmwy.wms.security.interceptor.JwtInterceptor

在swagger进行token测试

  1. 执行登陆操作，token见返回值中

image

返回值为：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "loginSysUser": {
      "id": "1",
      "userName": "admin"
    },
    "token": "eyJjdHkiOiJjdHkiLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ2b2xjYW5vLWp3dCIsImF1ZCI6IndlYiIsImlzcyI6InZvbGNhbm8iLCJleHAiOjE1Njg3MTI0MDcsImlhdCI6MTU2ODcxMDYwNywianRpIjoiNDM4NjMwMDAwOTlmNDFkNDk1Y2FlOWVkNWUzNDZhOTgifQ.wVZOx-J2knqUxdnRjRXZqr2nf1S-Qwmap2-0nGXJDXM"
  },
  "time": "2019-09-17 16:56:51"
}
  1. 点击 Authorize按钮

image

  1. 将token设置到value中，后面丝袜哥所有的请求都会带一个叫做“Authorization”的请求头。

在jwt拦截器JwtInterceptor中会获取该请求头进行校验。

image

项目启动和部署

单独作为项目使用

javasea-volcano默认是一个独立的springboot项目，可以直接启动javasea-volcano-base项目，在base项目的基础上，直接编写业务代码即可。

集成到现有的springcloud中

默认是独立项目，但是也可以轻松的集成到现有的springcloud环境中，只需要放开部分注释即可。

  1. 启用bootstrap.yml的配置(放开注释)
#spring:
#  cloud:
#    config:
#      uri: ${WMS_CONFIG_SERVER_URL}
#      name: zhirui-lmwy2-wms${WMS_DEVELOPER_NAME:}
#      profile: ${config.profile:dev}
#

  1. base项目的pom中开启对应eureka client的坐标，启动类WmsApplication通过注解@EnableDiscoveryClient启用eureka client。

    <!-- springboot 1.X -->
<!--<dependency>-->
   <!--<groupId>org.springframework.cloud</groupId>-->
   <!--<artifactId>spring-cloud-starter-eureka</artifactId>-->
<!--</dependency>-->
<!-- springboot 2.X -->
<!--<dependency>-->
   <!--<groupId>org.springframework.cloud</groupId>-->
   <!--<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>-->
<!--</dependency>-->
  2. IDE中配置vm参数，使用已经已经存在的eureka注册中心和配置中心

在IDE中配置VM参数只能是作为测试，如果需要部署后生效，那么需要配置到服务器的环境变量或者在启动的java -jar后添加配置。之后我会添加关于服务部署的文章。

-Dmultipart-location=D:/wms/temp
-DDiskLocation=D:/wms/
-DWMS_CONFIG_SERVER_URL=http://192.168.1.230:8861
-DWMS_EUREKA_SERVER_URL=http://192.168.1.230:8090/eureka/
-DWMS_DEVELOPER_NAME=-longxiaonan
-Dconfig.profile=dev

Maven方式打包

mvn clean package -Dmaven.test.skip=true
文章标签：
云数据库 Tair（兼容 Redis）
Java
NoSQL
Redis
前端开发
数据格式
关键词：
Spring boot mybatis
Spring Boot mybatis-plus
Spring Boot JWT
springboot jwt
jwt springboot
哮南
目录
相关文章
wanderInk
|
6月前
|
前端开发 安全 Java
Spring Boot 便利店销售系统项目分包设计解析
本文深入解析了基于Spring Boot的便利店销售系统分包设计，通过清晰的分层架构（表现层、业务逻辑层、数据访问层等）和模块化设计，提升了代码的可维护性、复用性和扩展性。具体分包结构包括`controller`、`service`、`repository`、`entity`、`dto`、`config`和`util`等模块，职责分明，便于团队协作与功能迭代。该设计为复杂企业级应用开发提供了实践参考。
wanderInk
240 0
2G冲浪词条
|
4月前
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目，接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件，创建`application.yml`进行相关配置，如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件，包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码，并在主类添加`@MapperScan`注解完成整合
2G冲浪词条
714 1
Spring boot 使用mybatis generator 自动生成代码插件
刘大猫.
|
3月前
|
Java 关系型数据库 MySQL
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
刘大猫.
388 2
刘大猫.
|
3月前
|
分布式计算 Java 大数据
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
刘大猫.
203 2
TiAmoZhang
|
3月前
|
Java 测试技术 Spring
简单学Spring Boot | 博客项目的测试
本内容介绍了基于Spring Boot的博客项目测试实践，重点在于通过测试驱动开发（TDD）优化服务层代码，提升代码质量和功能可靠性。案例详细展示了如何为PostService类编写测试用例、运行测试并根据反馈优化功能代码，包括两次优化过程。通过TDD流程，确保每项功能经过严格验证，增强代码可维护性与系统稳定性。
TiAmoZhang
168 0
TiAmoZhang
|
3月前
|
存储 Java 数据库连接
简单学Spring Boot | 博客项目的三层架构重构
本案例通过采用三层架构（数据访问层、业务逻辑层、表现层）重构项目，解决了集中式开发导致的代码臃肿问题。各层职责清晰，结合依赖注入实现解耦，提升了系统的可维护性、可测试性和可扩展性，为后续接入真实数据库奠定基础。
TiAmoZhang
307 0
啦啦啦191
|
4月前
|
Java 数据库连接 API
Java 对象模型现代化实践 基于 Spring Boot 与 MyBatis Plus 的实现方案深度解析
本文介绍了基于Spring Boot与MyBatis-Plus的Java对象模型现代化实践方案。采用Spring Boot 3.1.2作为基础框架，结合MyBatis-Plus 3.5.3.1进行数据访问层实现，使用Lombok简化PO对象，MapStruct处理对象转换。文章详细讲解了数据库设计、PO对象实现、DAO层构建、业务逻辑封装以及DTO/VO转换等核心环节，提供了一个完整的现代化Java对象模型实现案例。通过分层设计和对象转换，实现了业务逻辑与数据访问的解耦，提高了代码的可维护性和扩展性。
啦啦啦191
180 1
Unfailed_realme
|
3月前
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容，涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中，我了解到 IOC 是控制反转，把对象控制权交容器；DI 是依赖注入，有三种实现方式。Bean 有五种作用域，单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP，有失效场景和七种传播行为。AOP 是面向切面编程，动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心，还有那些常用注解的用法。 MyBatis 里，#{} 和 ${} 的区别很关键，获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
Unfailed_realme
126 0
程序员小假
|
4月前
|
网络协议 Java
在SpringBoot项目中使用Netty实现远程调用
本文介绍了使用Netty解决网络连接性能问题的方法，重点讲解了Netty的NIO特性及其在SpringBoot中的应用。Netty作为高效的NIO框架，支持非阻塞IO，能通过单线程管理多个客户端连接，简化TCP/UDP套接字服务器开发。文章详细展示了Netty在SpringBoot中实现远程调用的过程，包括服务端与客户端代码实现、依赖配置及测试验证。通过示例代码，如`NettyServer`、`NettyClientUtil`等，清晰说明了Netty的工作原理和实际应用，解决了半包等问题，并提供了完整的测试结果。
程序员小假
555 3
蓝易云
|
4月前
|
SQL Java 数据库
解决Java Spring Boot应用中MyBatis-Plus查询问题的策略。
保持技能更新是侦探的重要素质。定期回顾最佳实践和新技术。比如，定期查看MyBatis-Plus的更新和社区的最佳做法，这样才能不断提升查询效率和性能。
蓝易云
178 1

热门文章

最新文章

  • 1
    MyBatis分页
  • 2
    Mybatis基础使用知识（注解）
  • 3
    SpringBoot集成RocketMq
  • 4
    SpringBoot整合MQTT实战：基于EMQX实现双向设备通信
  • 5
    基于springboot的美食文化和旅游推广系统
  • 6
    基于springboot的大学公文收发管理系统
  • 7
    基于springboot的考研互助小程序
  • 8
    SpringBoot接口安全：限流、重放攻击、签名机制分析
  • 9
    SpringBoot从0-1集成Graalvm
  • 10
    基于springboot的母婴健康交流系统
  • 1
    session和JWT的应用及区别
    140
  • 2
    4.基础技术&API网关&JWT
    149
  • 3
    1天搞定SpringBoot+Vue全栈开发 (9)JWT跨域认证
    137
  • 4
    基于M实现的JWT解决方案
    183
  • 5
    前端的JWT怎么进行用户认证？
    156
  • 6
    Shiro + JWT 进行登录验证
    109
  • 7
    切图仔做全栈：React&Nest.js社区平台(一)——基础架构与邮箱注册、JWT登录实现
    290
  • 8
    Spring Security整合JWT
    352
  • 9
    Springboot+Spring security +jwt认证+动态授权
    412
  • 10
    Spring Security+jwt实现认证
    188

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移
  • MyBatis持久层框架入门

    • 相关电子书

    更多
  • workshop专场-微服务专场-开发者动手实践营-微服务-Spring Cloud Alibaba 微服务全家桶体验
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
    • 下一篇
    阿里云无影云电脑免费使用_免费申请教程