Skip to content

Commit

Permalink
bump: 发布1.11.0
Browse files Browse the repository at this point in the history
  • Loading branch information
uncarbon97 authored Feb 24, 2024
1 parent 03b3379 commit abbf8a1
Show file tree
Hide file tree
Showing 78 changed files with 1,757 additions and 523 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# helio-boot

## 项目介绍
`helio-boot`基于 Spring Boot 2.7.x,是一款预置SaaS、RBAC能力的单体项目脚手架,适合初学者学习 JavaWeb 开发的良好实践
基于 Spring Boot 2.7.x,是一款预置SaaS、RBAC能力的单体项目脚手架,适合初学者学习 JavaWeb 开发的良好实践
单Maven模块,定位为快速开发脚手架
多模块版请移步至[helio-boot-modular](https://github.com/uncarbon97/helio-boot-modular)项目

JDK compatibility: 1.8 - 17
JDK compatibility: 1.8 - 21

[前端演示站](https://helio-demo.uncarbon.cc/)
[官方文档](https://helio.uncarbon.cc/)
Expand All @@ -16,24 +18,13 @@ JDK compatibility: 1.8 - 17

基础支撑构件 [helio-starters](https://github.com/uncarbon97/helio-starters) 已推送至Maven中央仓库,加载时会自动拉取

## 配套后台管理前端模板 && 代码生成器
## 配套后台管理前端模板 & 代码生成器
| 项目名 | 简介 | Gitee | GitHub |
|----------------------|-----------------------------------------------------------------------------|------------------------------------------------------------|--------------------------------------------------------------|
| helio-generator | 可一键生成单体or微服务版的前、后端代码,减少无谓的重复劳动 | [Gitee](https://gitee.com/uncarbon97/helio-generator) | [GitHub](https://github.com/uncarbon97/helio-generator) |
| helio-admin-vue-vben | 基于[Vue vben admin](https://github.com/anncwb/vue-vben-admin) 改造适配的前端框架,开箱即用 | [Gitee](https://gitee.com/uncarbon97/helio-admin-vue-vben) | [GitHub](https://github.com/uncarbon97/helio-admin-vue-vben) |

## 代码分支
| 分支名 | 简介 |
|------------|-------------------------------------------------------------------|
| single/1.x | 单Maven模块,定位为快速开发脚手架,适合初学者学习 JavaWeb 开发的良好实践 |
| multi/1.x | 按职责拆分为多Maven模块,依然是大单体,但命名及用途对标`helio-cloud`;适合多人协作、但不打算使用微服务架构的团队 |

## 演示项目
| 项目名 | 后端 | 前端 | 需导入数据库文件 |
|----------------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| library 图书管理系统 | [Gitee](https://gitee.com/uncarbon97/helio-boot/tree/demo%2Flibrary/) | [Gitee](https://gitee.com/uncarbon97/helio-admin-vue-vben/tree/demo%2Flibrary/) | attachments/db/MySQL/helio_boot.sql<br>attachments/db/demo/library_MySQL.sql |

## 目录结构
## 源码包结构
```
├─attachments 附件
│ └─db 数据库变更脚本
Expand Down
12 changes: 12 additions & 0 deletions attachments/db/MySQL/upgrade/1.10.0_to_1.11.0.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
-- v1.11.0 - 「后台角色」中,`title`字段更名为「角色名」,`value`字段更名为「角色编码」
ALTER TABLE sys_role
MODIFY COLUMN title varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '角色名',
MODIFY COLUMN `value` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '角色编码';

-- v1.11.0 - 「数据字典」中,`value`字段更名为「数据值」
ALTER TABLE sys_data_dict
MODIFY COLUMN `value` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '数据值';

-- v1.11.0 - 扩充「后台用户」数据表,「昵称」字段的长度上限为255
ALTER TABLE sys_user
MODIFY COLUMN `nickname` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '' COMMENT '昵称';
10 changes: 10 additions & 0 deletions attachments/db/PostgreSQL/upgrade/1.10.0_to_1.11.0.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
-- v1.11.0 - 「后台角色」中,`title`字段更名为「角色名」,`value`字段更名为「角色编码」
COMMENT ON COLUMN "sys_role"."title" IS '角色名';
COMMENT ON COLUMN "sys_role"."value" IS '角色编码';

-- v1.11.0 - 「数据字典」中,`value`字段更名为「数据值」
COMMENT ON COLUMN "sys_data_dict"."value" IS '数据值';

-- v1.11.0 - 扩充「后台用户」数据表,「昵称」字段的长度上限为255
ALTER TABLE "sys_user"
ALTER COLUMN "nickname" TYPE varchar(255);
185 changes: 185 additions & 0 deletions checkstyle-v1.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">

<!-- 文件长度不超过2000行 -->
<module name="FileLength">
<property name="max" value="2000"/>
</module>

<!-- 每个java文件一个语法树 -->
<module name="TreeWalker">
<!-- import检查-->
<!-- 检查是否从非法的包中导入了类 -->
<module name="IllegalImport"/>
<!-- 检查是否导入了多余的包 -->
<module name="RedundantImport"/>
<!-- 没用的import检查,比如:1.没有被用到 2.重复的 3.import java.lang的 4.import 与该类在同一个package的 -->
<module name="UnusedImports" />

<!-- 注释检查 -->
<!-- 检查构造函数的javadoc -->
<!--
<module name="JavadocType">
<property name="allowUnknownTags" value="true"/>
<message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
</module>
-->

<!-- 命名检查 -->
<!-- 局部的final变量,包括catch中的参数的检查 -->
<module name="LocalFinalVariableName" />
<!-- 局部的非final型的变量,包括catch中的参数的检查 -->
<module name="LocalVariableName" />
<!-- 包名的检查(只允许小写字母),默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
<message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
</module>
<!-- 仅仅是static型的变量(不包括static final型)的检查 -->
<module name="StaticVariableName" />
<!-- Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$-->
<module name="TypeName">
<property name="severity" value="warning"/>
<message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
</module>
<!-- 非static型变量的检查 -->
<module name="MemberName" />
<!-- 方法名的检查 -->
<module name="MethodName" />
<!-- 方法的参数名 -->
<module name="ParameterName " />
<!-- 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
<module name="ConstantName" />

<!-- 定义检查 -->
<!-- 检查数组类型定义的样式 -->
<module name="ArrayTypeStyle"/>
<!-- 检查long型定义是否有大写的“L” -->
<module name="UpperEll"/>

<!-- 长度检查 -->
<!-- 每行不超过200个字符 -->
<module name="LineLength">
<property name="max" value="200" />
</module>
<!-- 方法不超过120行 -->
<module name="MethodLength">
<property name="tokens" value="METHOD_DEF" />
<property name="max" value="120" />
</module>
<!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
<module name="ParameterNumber">
<property name="max" value="5" />
<property name="ignoreOverriddenMethods" value="true"/>
<property name="tokens" value="METHOD_DEF" />
</module>

<!-- 空格检查-->
<!-- 方法名后跟左圆括号"(" -->
<module name="MethodParamPad" />
<!-- 在类型转换时,不允许左圆括号右边有空格,也不允许与右圆括号左边有空格 -->
<module name="TypecastParenPad" />
<!-- 检查在某个特定关键字之后应保留空格 -->
<module name="NoWhitespaceAfter"/>
<!-- 检查在某个特定关键字之前应保留空格 -->
<module name="NoWhitespaceBefore"/>
<!-- 操作符换行策略检查 -->
<module name="OperatorWrap"/>
<!-- 圆括号空白 -->
<module name="ParenPad"/>
<!-- 检查分隔符是否在空白之后 -->
<module name="WhitespaceAfter"/>
<!-- 检查分隔符周围是否有空白 -->
<module name="WhitespaceAround"/>

<!-- 修饰符检查 -->
<!-- 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
<module name="ModifierOrder"/>
<!-- 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public -->
<module name="RedundantModifier"/>

<!-- 代码块检查 -->
<!-- 检查是否有嵌套代码块 -->
<module name="AvoidNestedBlocks"/>
<!-- 检查是否有空代码块 -->
<module name="EmptyBlock"/>
<!-- 检查左大括号位置 -->
<module name="LeftCurly"/>
<!-- 检查代码块是否缺失{} -->
<module name="NeedBraces"/>
<!-- 检查右大括号位置 -->
<module name="RightCurly"/>

<!-- 代码检查 -->
<!-- 检查空的代码段 -->
<module name="EmptyStatement"/>
<!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
<module name="EqualsHashCode"/>
<!-- 检查局部变量或参数是否隐藏了类中的变量 -->
<module name="HiddenField">
<property name="tokens" value="VARIABLE_DEF"/>
</module>
<!-- 检查子表达式中是否有赋值操作 -->
<module name="InnerAssignment"/>
<!-- 检查switch语句是否有default -->
<module name="MissingSwitchDefault"/>
<!-- 检查是否有过度复杂的布尔表达式 -->
<module name="SimplifyBooleanExpression"/>
<!-- 检查是否有过于复杂的布尔返回代码段 -->
<module name="SimplifyBooleanReturn"/>

<!-- 类设计检查 -->
<!-- 检查类是否为扩展设计l -->
<!-- 检查只有private构造函数的类是否声明为final -->
<module name="FinalClass"/>
<!-- 检查接口是否仅定义类型 -->
<module name="InterfaceIsType"/>
<!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
<module name="VisibilityModifier">
<property name="packageAllowed" value="true"/>
<property name="protectedAllowed" value="true"/>
</module>

<!-- 语法 -->
<!-- String的比较不能用!= 和 == -->
<module name="StringLiteralEquality"/>
<!-- 限制for循环最多嵌套2层 -->
<module name="NestedForDepth">
<property name="max" value="2"/>
</module>
<!-- if最多嵌套3层 -->
<module name="NestedIfDepth">
<property name="max" value="3"/>
</module>
<!-- 检查未被注释的main方法,排除以Application、Test结尾命名的类 -->
<module name="UncommentedMain">
<property name="excludedClasses" value=".*[Application,Test]$"/>
</module>
<!-- 禁止使用System.out.println -->
<module name="Regexp">
<property name="format" value="System\.out\.println"/>
<property name="illegalPattern" value="true"/>
</module>
<!-- return个数 5个-->
<module name="ReturnCount">
<property name="max" value="5"/>
</module>
<!--try catch 异常处理数量 3-->
<module name="NestedTryDepth ">
<property name="max" value="3"/>
</module>
<!-- clone方法必须调用了super.clone() -->
<module name="SuperClone" />
<!-- finalize 必须调用了super.finalize() -->
<module name="SuperFinalize" />


</module>
</module>
<!-- https://blog.csdn.net/liuwei0376/article/details/123180920 -->
<!-- 依赖checkstyle 8.14版本-->
7 changes: 4 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@
<parent>
<groupId>cc.uncarbon.framework</groupId>
<artifactId>helio-starters</artifactId>
<version>1.10.0</version>
<version>1.11.0</version>
</parent>

<artifactId>helio-boot</artifactId>
<description>Helio 单模块版单体脚手架</description>
<!-- 制品版本号,建议每次打包发布时都调整以作区分 -->
<version>1.10.0</version>
<version>1.11.0</version>

<properties>
<!-- 这里写其他第三方依赖 -->
<!-- 文件上传 -->
<x-file-storage.version>2.0.0</x-file-storage.version>
<x-file-storage.version>2.1.0</x-file-storage.version>
<minio.version>8.4.3</minio.version>
</properties>

Expand Down
Loading

0 comments on commit abbf8a1

Please sign in to comment.