前言

闲来无事,整一个 Java 项目快速开发脚手架。

正文

一、简介

Chewing 是一个简单的 Java 项目快速开发脚手架。既适合需要开发小型项目的小伙伴使用,也适合刚入门的新手用来学习一些常用的技术。

二、源码

源码地址:https://github.com/jingqueyimu/chewing

三、核心技术

1、后端

  • SpringBoot:Web 应用框架。
  • Mybatis:持久层框架。
  • MySQL:关系型数据库。
  • Redis:缓存数据库。
  • RabbitMQ:消息队列中间件。

2、前端

  • Themeleaf:模板引擎。
  • Bootstrap:UI 框架。

四、环境部署

1、准备工作

  • JDK 1.8
  • MySQL 5.7
  • Maven 3.x
  • Redis
  • RabbitMQ

2、必要配置

  • application.properties 配置文件:数据库、Redis、RabbitMQ、邮箱等配置。
  • config/myconfig.properties 配置文件:系统相关的自定义配置。

五、项目介绍

1、文件结构

src/main/java
|— com.jingqueyimu
|— annotation // 注解
|— aspect // 切面
|— config // 配置
|— constant // 常量
|— context // 上下文
|— controller // 控制层
|— exception // 异常
|— factory // 工厂
|— filter // 过滤器
|— handler // 处理器
|— init // 初始化
|— interceptor // 拦截器
|— mapper // 持久层
|— model // 数据模型
|— mq // 消息队列
|— schedule // 调度
|— service // 服务层
|— util // 工具
MyAppcation.java // 应用启动类
src/main/resources
|— config // 配置文件
|— mapper // 映射文件
|— static // 静态文件
|— templates // 页面文件
application.properties // 应用配置文件
quartz.properties // 调度配置文件

2、代码说明

(1)路由

  • /api/xxx:需要用户登录。
  • /console/xxx:需要管理员登录,登录、登出等部分接口除外。

(2)接口规范

  • 页面请求:GET、URL 参数。
  • 接口请求:POST、JSON 参数。

(3)数据库初始化

  • 初始化配置文件:config/dbinit.json。
  • 配置初始化标识及 SQL 语句。

初始化示例:

[
{
"initKey": "site_config_20210110",
"sqls": [
"INSERT INTO t_site_config (id, code, name, content, description, public_flag, gmt_create) VALUES(NULL, 'site_record_no', '网站备案号', '<a href=\"https://beian.miit.gov.cn\" class=\"ml-2\" target=\"_blank\">备案号</a>', '网站备案号', true, NOW());"
]
}
]

(4)文件上传下载

  • 上传单个文件:/file/upload。
  • 上传多个文件:/file/uploads。
  • 下载文件:/file/download。

(5)Excel 导入导出

  • Excel 导入导出方法:ExcelUtil.importExcel()、ExcelUtil.exportExcel()。
  • Excel 导入导出处理器接口:IExcelImportHandler、IExcelExportHandler。

导入示例:

String msg = null;
try {
String[] keys = new String[] {"username", "realName", "mobile"};
msg = ExcelUtil.importExcel(file.getInputStream(), keys, new IExcelImportHandler() { @Override
public void handle(JSONObject data) {
if (StringUtils.isBlank(data.getString("username"))) {
throw new RuntimeException("用户名不能为空");
}
if (StringUtils.isBlank(data.getString("mobile"))) {
throw new RuntimeException("手机号不能为空");
}
// 业务处理
}
});
log.info(msg);
} catch (IOException e) {
e.printStackTrace();
}

导出示例:

ServletOutputStream os = null;
try {
String fileName = "用户列表";
...
// 用户列表数据
List<User> list = userService.list(params);
// 表头
String[] headers = new String[] {"编号 ", "用户名", "姓名", "手机号", "邮箱", "注册方式", "注册时间", "上次登录时间", "是否VIP"};
os = response.getOutputStream();
// 导出
ExcelUtil.exportExcel(fileName, list, headers, os, new IExcelExportHandler<User>() { @Override
public List<Object> handle(User user) {
List<Object> rowDatas = new ArrayList<>();
rowDatas.add(user.getId());
rowDatas.add(user.getUsername());
rowDatas.add(user.getRealName());
rowDatas.add(user.getMobile());
rowDatas.add(user.getEmail());
rowDatas.add(RegisterType.getEnum(user.getRegisterType()).getValue());
rowDatas.add(DateUtil.format(user.getRegisterTime(), "yyyy-MM-dd HH:mm:ss"));
rowDatas.add(user.getLastLoginTime() == null ? "" : DateUtil.format(user.getLastLoginTime(), "yyyy-MM-dd HH:mm:ss"));
rowDatas.add(Boolean.TRUE.equals(user.getVipFlag()) ? "是" : "否");
return rowDatas;
}
});
} catch (IOException e) {
e.printStackTrace();
} finally {
...
}

(6)获取字典

  • 获取单个字典:/common/dict。
  • 获取多个字典:/common/dicts。

(7)上下文信息

  • UserContext:用户上下文信息。
  • AdminContext:管理员上下文信息。

(8)调度

  • 新增调度任务:继承 BaseJob。
  • 调度接口
    • 执行调度任务:/console/schedule_job/run。
    • 修改调度状态:/console/schedule_job/update_status。
    • 修改调度频率:/console/schedule_job/update_cron。

(9)注解

  • @Lock:分布式锁。
  • @Perm:标注需要管理员权限的接口。

(10)配置文件

  • 由于个人习惯,项目中使用的是 properties 配置文件,对于习惯使用 yml 配置文件的,请手动修改。
  • 如果要加载自定义的 yml 配置文件,可以使用项目中提供的 YAML 属性源工厂类:YamlPropertySourceFactory。

代码示例:

@Component
@ConfigurationProperties(prefix="test")
@PropertySource(value="classpath:config/test.yml", encoding="UTF-8", factory=YamlPropertySourceFactory.class)
public class TestYmlConfig {
...
}

(11)属性名后缀匹配查询条件

BaseService 中以 JSON 对象为参数的方法,可通过在属性名后面添加后缀,来匹配查询条件。

  • xxx_begin:大于等于。
  • xxx_end:小于等于。
  • xxx_in:IN 查询。
  • xxx_like:模糊查询。
  • xxx_llike:左模糊查询。
  • xxx_rlike:右模糊查询。
  • 其他:等于。
  • 属性值为空:不参与查询。

代码示例:

@Test
public void test() {
JSONObject params = new JSONObject();
params.put("username_like", "test");
List<User> user = userService.list(params);
System.out.println(user);
} @Test
public void test2() {
JSONObject params = new JSONObject();
params.put("username_in", Arrays.asList("test"));
List<User> user = userService.list(params);
System.out.println(user);
}

(12)...

六、演示图

1、前台

2、后台

结语

目前,Chewing 还只是提供了一些较为常用的功能(实在是肝不动了)。但是,后续会不断完善、新增功能。有时间的话,也会整一个微服务版的。

敬请期待~

交流区



微信公众号:惊却一目

个人博客:惊却一目

肝了一个半月的 Java 项目快速开发脚手架:Chewing的更多相关文章

  1. Maven:如何在eclipse里新建一个Maven的java项目和web项目

    如何在eclipse里新建一个Maven的java项目和web项目: 一:java项目 New-->Other-->Maven 右击项目-->properties,修改以下文件: ① ...

  2. 基于ABP开发框架的技术点分析和项目快速开发实现

    在我们开发各种项目应用的时候,往往都是基于一定框架进行,同时配合专用的代码生成工具,都是为了快速按照固定模式开发项目,事半功倍,本篇随笔对基于ABP开发框架的技术点进行分析和ABP框架项目快速开发实现 ...

  3. AgileBoot - 基于SpringBoot + Vue3的前后端快速开发脚手架

    AgileBoot 仓库 后端地址:https://github.com/valarchie/AgileBoot-Back-End 技术栈:Springboot / Spring Security / ...

  4. Amoeba是一个类似MySQL Proxy的分布式数据库中间代理层软件,是由陈思儒开发的一个开源的java项目

    http://www.cnblogs.com/xiaocen/p/3736095.html amoeba实现mysql读写分离 application  shang  2年前 (2013-03-28) ...

  5. Java爬虫快速开发工具uncs的部署攻略

    写在前面 uncs是java快速开发爬虫的工具,简单便捷,经过大量版本迭代和生产验证,可以适用大多数网站,推荐使用. 一.基本用法 1.1 开发包获取 目前只能在公司内网maven服务器获取到 < ...

  6. 从壹开始 [vueAdmin后台] 之三 || 动态路由配置 & 项目快速开发

    回顾 今天VS 2019正式发布,实验一波,你安装了么?Blog.Core 预计今天会升级到 Core 3.0 版本. 哈喽大家周三好!本来今天呢要写 Id4 了,但是写到了一半,突然有人问到了关于 ...

  7. JAVA企业级快速开发平台,JEECG 3.7.3 新春版本发布

    JEECG 3.7.3新春版本发布 -  微云快速开发平台 导读           ⊙精美Echart报表 ⊙二维码生成功能 ⊙Online接口改造采用JWT机制 ⊙智能菜单搜索 ⊙代码生成器模板优 ...

  8. java工作流快速开发之授权代办的设计

    关键词:工作流快速开发平台  工作流流设计  业务流程管理 Java工作流引擎 asp.net 开源工作流  net开源工作流引擎 开源工作流系统 一.授权代办开发背景 应用需求:项目审批人出差无法及 ...

  9. AgileRepository - 一个基于接口的Repository快速开发库

    AgileRepository 这是一个可以帮助你快速开发Repository的lib.有点像SpringData JPA根据方法名.注解来自动生成查询方法的功能. 对于一些简单的查询,只需要定义接口 ...

随机推荐

  1. Java入门随手记-DOS命令

    DOS 打开cmd的方式 开始+系统+命令提示符 win键+r 输入cmd打开控制台(推荐使用) 在任意的文件夹下面,按住shift键+鼠标右键点击,在此次打开命令窗口 资源管理器的地址栏前面加上cm ...

  2. MySQL--运行机制,SQL执行顺序,Explain

    MySQL的运行机制是什么?  首先客户端先要发送用户信息去服务器端进行授权认证,当输入正确密码之后可以连接到数据库了,当连接服务器端成功之后就可以正常的执行 SQL 命令了,MySQL 服务器拿到 ...

  3. Docker-ce Centos8 笔记二:常见问题

  4. C++ 简单输出当前日期时间

    根据https://www.runoob.com/cplusplus/cpp-date-time.html编写. 首先介绍2个数据类型. 一个是time_t,与时间函数相关的变量,定义的变量记录着自 ...

  5. 【JavaWeb】书城项目

    书城网站 项目说明 项目地址 阶段一 登录.注册的验证 使用 jQuery 技术对登录中的用户名.密码进行非空验证: 使用 jQuery 技术和正则表达式对注册中的用户名.密码.确认密码.邮箱进行格式 ...

  6. 【Oracle】将数据库设为开机自启

    由于某些特殊条件,需要将oracle数据库设置为开机自己,其实很简单 环境:oracle10gR2 1.修改/etc/oratab # This file is used by ORACLE util ...

  7. awk中引用shell变量的方法

    1.通过命令行参数定义变量时引用: awk -v awk变量名= shell变量名 #!/bin/bash var4bash=test awk -v var4awk="$var4bash&q ...

  8. Linux Ubuntu系统版本通过Crontab设置定时任务的执行

    Linux Ubuntu系统版本通过Crontab设置定时任务的执行 本文由本人收集网络信息总结而来 特别鸣谢:https://linux.zone/2258 1 crontab 简单介绍以及语法使用 ...

  9. linux自定义位置安装tomcat8.5

    1 下载tomcat安装文件 下载地址:https://tomcat.apache.org/download-80.cgi  2 解压文件 tar -zxvf apache-tomcat-8.5.56 ...

  10. 使用git同步代码

    方法1.先把远程仓库clone到本地,本地修改后再push到gitee的远程仓库 1. 配置本地的git配置信息 git config -l #查看git本地配置信息 # 如果没有配置,需要配置自己的 ...