之前开源了一款我的项目骨架mall-tiny,残缺继承了mall我的项目的整个技术栈。总感觉mall-tiny集成了太多中间件,过于简单了。这次对其进行了简化和降级,使它成为了一款领有残缺权限治理性能的疾速开发脚手架,心愿对大家有所帮忙!

SpringBoot实战电商我的项目mall(40k+star)地址:https://github.com/macrozheng/mall

简介

mall-tiny是一款基于SpringBoot+MyBatis-Plus的疾速开发脚手架,领有残缺的权限治理性能,可对接Vue前端,开箱即用。

我的项目演示

mall-tiny我的项目可无缝对接mall-admin-web前端我的项目,秒变权限管理系统。前端我的项目地址:https://github.com/macrozheng...

技术选型

技术版本阐明
SpringBoot2.3.0容器+MVC框架
SpringSecurity5.3.2认证和受权框架
MyBatis3.5.4ORM框架
MyBatis-Plus3.3.2MyBatis加强工具
MyBatis-Plus Generator3.3.2数据层代码生成器
Swagger-UI2.9.2文档生产工具
Redis5.0分布式缓存
Docker18.09.0利用容器引擎
Druid1.1.10数据库连接池
JWT0.9.0JWT登录反对
Lombok1.18.12简化对象封装工具

数据库表构造

  • 化繁为简,仅保留了权限治理性能相干的9张表,不便自在定制;
  • 数据库源文件地址:https://github.com/macrozheng...

应用流程

环境搭建

简化依赖服务,只需装置最罕用的MySql和Redis服务即可,服务装置具体参考《mall在Windows环境下的部署》,数据库中须要导入mall_tiny.sql脚本。

开发规约

我的项目包构造

src├── common -- 用于寄存通用代码|   ├── api -- 通用后果集封装类|   ├── config -- 通用配置类|   ├── domain -- 通用封装对象|   ├── exception -- 全局异样解决相干类|   └── service -- 通用业务类├── config -- SpringBoot中的Java配置├── domain -- 共用封装对象├── generator -- MyBatis-Plus代码生成器├── modules -- 寄存业务代码的根底包|   └── ums -- 权限治理模块业务代码|       ├── controller -- 该模块相干接口|       ├── dto -- 该模块数据传输封装对象|       ├── mapper -- 该模块相干Mapper接口|       ├── model -- 该模块相干实体类|       └── service -- 该模块相干业务解决类└── security -- SpringSecurity认证受权相干代码    ├── annotation -- 相干注解    ├── aspect -- 相干切面    ├── component -- 认证受权相干组件    ├── config -- 相干配置    └── util -- 相干工具类

资源文件阐明

resources├── mapper -- MyBatis中mapper.xml寄存地位├── application.yml -- SpringBoot通用配置文件├── application-dev.yml -- SpringBoot开发环境配置文件├── application-prod.yml -- SpringBoot生产环境配置文件└── generator.properties -- MyBatis-Plus代码生成器配置

接口定义规定

  • 创立表记录:POST /{控制器路由名称}/create
  • 批改表记录:POST /{控制器路由名称}/update/{id}
  • 删除指定表记录:POST /{控制器路由名称}/delete/{id}
  • 分页查问表记录:GET /{控制器路由名称}/list
  • 获取指定记录详情:GET /{控制器路由名称}/{id}
  • 具体参数及返回后果定义能够运行代码查看Swagger-UI的Api文档:http://localhost:8080/swagger-ui.html

我的项目运行

间接运行启动类MallTinyApplicationmain函数即可。

业务代码开发流程

创立业务表

创立好pms模块的所有表,须要留神的是肯定要写好表字段的正文,这样实体类和接口文档中就会主动生成字段阐明了。

应用代码生成器

运行MyBatisPlusGenerator类的main办法来生成代码,可间接生成controller、service、mapper、model、mapper.xml的代码,无需手动创立。
  • 代码生成器反对两种模式,一种生成单表的代码,比方只生成pms_brand表代码能够先输出pms,后输出pms_brand

  • 生成代码构造一览;

  • 另一种间接生成整个模块的代码,比方生成pms模块代码能够先输出pms,后输出pms_*

编写业务代码

单表查问
因为MyBatis-Plus提供的加强性能相当弱小,单表查问简直不必手写SQL,间接应用ServiceImpl和BaseMapper中提供的办法即可。

比方咱们的菜单治理业务实现类UmsMenuServiceImpl中的办法都间接应用了这些办法。

/** * 后盾菜单治理Service实现类 * Created by macro on 2020/2/2. */@Servicepublic class UmsMenuServiceImpl extends ServiceImpl<UmsMenuMapper,UmsMenu>implements UmsMenuService {    @Override    public boolean create(UmsMenu umsMenu) {        umsMenu.setCreateTime(new Date());        updateLevel(umsMenu);        return save(umsMenu);    }    @Override    public boolean update(Long id, UmsMenu umsMenu) {        umsMenu.setId(id);        updateLevel(umsMenu);        return updateById(umsMenu);    }    @Override    public Page<UmsMenu> list(Long parentId, Integer pageSize, Integer pageNum) {        Page<UmsMenu> page = new Page<>(pageNum,pageSize);        QueryWrapper<UmsMenu> wrapper = new QueryWrapper<>();        wrapper.lambda().eq(UmsMenu::getParentId,parentId)                .orderByDesc(UmsMenu::getSort);        return page(page,wrapper);    }    @Override    public List<UmsMenuNode> treeList() {        List<UmsMenu> menuList = list();        List<UmsMenuNode> result = menuList.stream()                .filter(menu -> menu.getParentId().equals(0L))                .map(menu -> covertMenuNode(menu, menuList)).collect(Collectors.toList());        return result;    }    @Override    public boolean updateHidden(Long id, Integer hidden) {        UmsMenu umsMenu = new UmsMenu();        umsMenu.setId(id);        umsMenu.setHidden(hidden);        return updateById(umsMenu);    }}
分页查问
对于分页查问MyBatis-Plus原生反对,不须要再整合其余插件,间接结构Page对象,而后调用ServiceImpl中的page办法即可。
/** * 后盾菜单治理Service实现类 * Created by macro on 2020/2/2. */@Servicepublic class UmsMenuServiceImpl extends ServiceImpl<UmsMenuMapper,UmsMenu>implements UmsMenuService {    @Override    public Page<UmsMenu> list(Long parentId, Integer pageSize, Integer pageNum) {        Page<UmsMenu> page = new Page<>(pageNum,pageSize);        QueryWrapper<UmsMenu> wrapper = new QueryWrapper<>();        wrapper.lambda().eq(UmsMenu::getParentId,parentId)                .orderByDesc(UmsMenu::getSort);        return page(page,wrapper);    }}
多表查问
对于多表查问,咱们须要手写mapper.xml中的SQL实现,因为之前咱们曾经生成了mapper.xml文件,所以咱们间接在Mapper接口中定义好办法,而后在mapper.xml写好SQL实现即可。
  • 比如说咱们须要写一个依据用户ID获取其调配的菜单的办法,首先咱们在UmsMenuMapper接口中增加好getMenuList办法;
/** * <p> * 后盾菜单表 Mapper 接口 * </p> * * @author macro * @since 2020-08-21 */public interface UmsMenuMapper extends BaseMapper<UmsMenu> {    /**     * 依据后盾用户ID获取菜单     */    List<UmsMenu> getMenuList(@Param("adminId") Long adminId);}
  • 而后在UmsMenuMapper.xml增加该办法的对应SQL实现即可。
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.macro.mall.tiny.modules.ums.mapper.UmsMenuMapper">    <select id="getMenuList" resultType="com.macro.mall.tiny.modules.ums.model.UmsMenu">        SELECT            m.id id,            m.parent_id parentId,            m.create_time createTime,            m.title title,            m.level level,            m.sort sort,            m.name name,            m.icon icon,            m.hidden hidden        FROM            ums_admin_role_relation arr                LEFT JOIN ums_role r ON arr.role_id = r.id                LEFT JOIN ums_role_menu_relation rmr ON r.id = rmr.role_id                LEFT JOIN ums_menu m ON rmr.menu_id = m.id        WHERE            arr.admin_id = #{adminId}          AND m.id IS NOT NULL        GROUP BY            m.id    </select>    </mapper>

我的项目部署

mall-tiny曾经集成了Docker插件,能够打包成Docker镜像来部署,具体参考:《应用Maven插件为SpringBoot利用构建Docker镜像》

其余阐明

SpringSecurity相干

因为应用了SpringSecurity来实现认证和受权,局部接口须要token才能够拜访,拜访须要认证受权接口流程如下。
  • 拜访Swagger-UI接口文档:http://localhost:8080/swagger-ui.html
  • 调用登录接口获取token;

  • 点击右上角Authorize按钮输出token,而后拜访相干接口即可。

申请参数校验

默认集成了Jakarta Bean Validation参数校验框架,只需在参数对象属性中增加javax.validation.constraints包中的注解注解即可实现校验性能,这里以登录参数校验为例。
  • 首先在登录申请参数中增加@NotEmpty注解;
/** * 用户登录参数 * Created by macro on 2018/4/26. */@Data@EqualsAndHashCode(callSuper = false)public class UmsAdminLoginParam {    @NotEmpty    @ApiModelProperty(value = "用户名",required = true)    private String username;    @NotEmpty    @ApiModelProperty(value = "明码",required = true)    private String password;}
  • 而后在登录接口中增加@Validated注解开启参数校验性能即可。
/** * 后盾用户治理 * Created by macro on 2018/4/26. */@Controller@Api(tags = "UmsAdminController", description = "后盾用户治理")@RequestMapping("/admin")public class UmsAdminController {    @ApiOperation(value = "登录当前返回token")    @RequestMapping(value = "/login", method = RequestMethod.POST)    @ResponseBody    public CommonResult login(@Validated @RequestBody UmsAdminLoginParam umsAdminLoginParam) {        String token = adminService.login(umsAdminLoginParam.getUsername(), umsAdminLoginParam.getPassword());        if (token == null) {            return CommonResult.validateFailed("用户名或明码谬误");        }        Map<String, String> tokenMap = new HashMap<>();        tokenMap.put("token", token);        tokenMap.put("tokenHead", tokenHead);        return CommonResult.success(tokenMap);    }}

我的项目地址

开源不易,感觉我的项目有帮忙的话点个Star反对下吧!

https://github.com/macrozheng...