之前开源了一款项目骨架mall-tiny,完整继承了mall项目的整个技术栈。总感觉mall-tiny集成了太多中间件,过于复杂了。这次对其进行了简化和升级,使它成为了一款拥有完整权限管理功能的快速开发脚手架,希望对大家有所帮助!

简介

mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架,拥有完整的权限管理功能,可对接Vue前端,开箱即用。

项目演示

mall-tiny项目可无缝对接mall-admin-web前端项目,秒变权限管理系统。

技术选型

数据库表结构

  • 化繁为简,仅保留了权限管理功能相关的9张表,方便自由定制;

使用流程

环境搭建

简化依赖服务,只需安装最常用的MySql和Redis服务即可,数据库中需要导入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

项目运行

直接运行启动类MallTinyApplication的main函数即可。

业务代码开发流程

创建业务表

创建好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.*/
@Service
public class UmsMenuServiceImpl extends ServiceImpl<UmsMenuMapper,UmsMenu>implements UmsMenuService {@Overridepublic boolean create(UmsMenu umsMenu) {umsMenu.setCreateTime(new Date());updateLevel(umsMenu);        return save(umsMenu);}    @Overridepublic boolean update(Long id, UmsMenu umsMenu) {umsMenu.setId(id);        updateLevel(umsMenu);        return updateById(umsMenu);}    @Overridepublic 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);}    @Overridepublic 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;}    @Overridepublic 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镜像来部署

其他说明

SpringSecurity相关

由于使用了SpringSecurity来实现认证和授权,部分接口需要token才可以访问,访问需要认证授权接口流程如下。

  • 访问Swagger-UI接口文档
  • 调用登录接口获取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)@ResponseBodypublic 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);}}

原文链接:还在从零开始搭建项目?手撸了款快速开发脚手架! - 掘金

umi脚手架搭建的项目_还在从零开始搭建项目?手撸了款快速开发脚手架!相关推荐

  1. 还在从零开始搭建项目?手撸了款快速开发脚手架!

    简介 mall-tiny是一款基于SpringBoot+MyBatis-Plus的快速开发脚手架,拥有完整的权限管理功能,可对接Vue前端,开箱即用.   项目演示 mall-tiny项目可无缝对接m ...

  2. java 脚手架_肝了一个半月的 Java 项目快速开发脚手架:Chewing

    前言 闲来无事,整一个 Java 项目快速开发脚手架. 正文 一.简介 Chewing 是一个简单的 Java 项目快速开发脚手架.既适合需要开发小型项目的小伙伴使用,也适合刚入门的新手用来学习一些常 ...

  3. spring boot 搭建的一个企业级快速开发脚手架

    源码地址 https://github.com/javanan/slife slife spring boot 搭建的一个企业级快速开发脚手架. 技术栈 Spring Boot MySQL Freem ...

  4. 5个开源的Java项目快速开发脚手架,项目经验有了

    今天推荐几个 Java 项目快速开发脚手架,解放双手 ✋ 从现在开始. 以下推荐项目都是码云上的优质项目,并且都是项目快速开发脚手架,代码质量什么的无法保证能有多好,毕竟很多也是个人开发,或多或少也有 ...

  5. 阿里工作流引擎_免费开源,一款快速开发模块化脚手架,含工作流引擎

    简介 lenosp 一款快速开发模块化脚手架,采用 spring boot 2.0.1.spring.SpringMvc.mybatis.shiro.activiti 工作流.swagger.ehca ...

  6. lenos快速开发脚手架

    2019独角兽企业重金招聘Python工程师标准>>> lenos一款快速开发模块化脚手架, lenos(p为spring boot版本扩展名)一款快速开发模块化脚手架,采用spri ...

  7. 一个java web 快速开发脚手架思路

    一个java web 快速开发脚手架思路 认证与鉴权 表 用户表.角色表.接口表.管理员表.用户角色关联表.角色接口关联表.接口分类表 代码生成 表 代码生成配置简单表.代码生成配置完整表 表说明 代 ...

  8. github项目怎么运行_利用 GitHub 从零开始搭建一个博客

    "NightTeam",一个值得加星标的公众号. 趁着周末,搭建了一下 NightTeam 的官方博客和官方主页,耗时数个小时,两个站点终于完工了. 由于 NightTeam 的域 ...

  9. eclipse创建springboot项目_创建一个 Spring Boot 项目,你会几种方法?

    我最早是 2016 年底开始写 Spring Boot 相关的博客,当时使用的版本还是 1.4.x ,文章发表在 CSDN 上,阅读量最大的一篇有 42W+,如下图: 2017 年由于种种原因,就没有 ...

最新文章

  1. vectorbool不是容器
  2. c++ 如何获取移动硬盘型号信息_工程销售,如何高效快速获取项目信息
  3. 2021-2025年中国电影发行行业市场供需与战略研究报告
  4. repeater上EVAL绑定后台方法并且传参数
  5. alter table *** add constraint *** 用法---约束
  6. 夺命雷公狗---linux NO:26 linux下的用户和用户组的管理
  7. 编程语言对高手没有差别,对低手差别太明显
  8. 致远项目管理SPM系统与BIM实现信息集成
  9. 记一次JAVA ssm+mysql 开发
  10. Shell按关键字删除重复行
  11. 你和你的女神之间,差了一个OpenCV口红色号识别器
  12. 曾国藩:凡读书,不必苦求强记
  13. SpringCloud学习笔记(八)Gateway 网关
  14. 博士读一半,导师跳槽了!博士生把亲身经历发在了Science上
  15. 推荐三个图片编辑软件给你
  16. Unity用UnityWebRequest和 BestHttp的GET和POST表单提交,与php交互
  17. 【HaaS Python硬件积木】土壤湿度传感器
  18. Unity游戏开发客户端面经——热更新(初级)
  19. python 动态相册,python3爬取动态网站图片
  20. 求一个数的每一位分别是多少

热门文章

  1. mysql5.6.40免安装版配置方案
  2. android 多进程 坑,Android 开发中踩过的坑之八:多进程问题
  3. postgresql 创建用户_PostgreSQL创建用户和修改用户密码
  4. 未找到 arp 项。_高新热力公司抢工期保供暖 42项新建改造项目全部完工
  5. 中科大410分计算机排名第几,2021考研成绩发布:中科大400分无缘复试,中山大学321分登顶第二...
  6. java基础知识点(6)——循环语句for-while
  7. 建模大师怎么安装到revit中_工程师最爱的REVIT插件,让BIM建模溜到飞起!
  8. python的动态参数
  9. val_loss突然变很大_有没有那么一瞬间,你突然觉得释然了?
  10. openfilename 选择文件夹_这个软件能帮你1秒内搜索文件夹中的东西