Skip to content

Commit

Permalink
style: 优化全局代码格式
Browse files Browse the repository at this point in the history
  • Loading branch information
Charles7c committed Jan 10, 2024
1 parent 4fefdc7 commit 35e3123
Show file tree
Hide file tree
Showing 97 changed files with 841 additions and 1,107 deletions.
File renamed without changes.
File renamed without changes.
810 changes: 347 additions & 463 deletions code-style/code-formatter.xml → .style/p3c-codestyle.xml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ ContiNew Admin(Continue New Admin)持续迭代优化的前后端分离中后
- 前后端统一异常拦截处理,统一输出异常信息,避免繁琐的异常判断
- 自动初始化数据:通过 Liquibase 管理数据库脚本版本记录,并在系统第一次启动时自动进行数据初始化,无须额外配置导入
- 提供多项实用基础配置,例如:Jackson 针对日期、通用枚举的序列化、反序列化配置,统一线程池配置等
- 良好的代码、配置文件结构和命名,完善的代码注释甚至包括 Git Commit 信息、接口文档参数示例,遵循阿里巴巴 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 的代码规范,保证代码质量和可维护性
- 良好的代码、配置文件结构和命名,完善的代码注释甚至包括 Git Commit 信息、接口文档参数示例,遵循阿里巴巴 <a href="https://github.com/Charles7c/continew-admin/blob/dev/.style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 的代码规范,保证代码质量和可维护性
- 更多细节及实践,敬请探索与关注

## 系统功能
Expand Down Expand Up @@ -395,7 +395,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
> **IMPORTANT**
> 欢迎大家为 ContiNew Admin 贡献代码,我们非常感谢您的支持!为了更好地管理项目,维护者有一些要求:
>
> 1. 请确保代码、配置文件的结构和命名规范良好,完善的代码注释甚至包括接口文档参数示例,并遵循阿里巴巴的 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 中的代码规范,保证代码质量和可维护性
> 1. 请确保代码、配置文件的结构和命名规范良好,完善的代码注释甚至包括接口文档参数示例,并遵循阿里巴巴的 <a href="https://github.com/Charles7c/continew-admin/blob/dev/.style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 中的代码规范,保证代码质量和可维护性
> 2. 在提交代码前,请按照 [Angular 提交规范](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) 编写 commit 的 message(建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件,以便按照规范进行 commit)
> 3. 提交代码之前,请关闭所有代码窗口,执行 mvn compile 命令(项目已配置代码格式化插件,编译通过的同时也会自动进行代码格式化),编译通过后,不要再打开查看任何代码窗口,直接提交即可,以免不同的 IDE 配置会自动进行代码格式化
Expand Down
8 changes: 0 additions & 8 deletions code-style/STYLE.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public class SpringCacheConfiguration extends CachingConfigurerSupport {
@Bean
public RedisCacheConfiguration redisCacheConfiguration(CacheProperties cacheProperties) {
ObjectMapper objectMapperCopy = objectMapper.copy();
objectMapperCopy.activateDefaultTyping(objectMapperCopy.getPolymorphicTypeValidator(),
ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
objectMapperCopy.activateDefaultTyping(objectMapperCopy
.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
.serializeValuesWith(RedisSerializationContext.SerializationPair
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,19 @@ public CellDataTypeEnum supportExcelTypeKey() {
* 转换为 Java 数据(读取 Excel)
*/
@Override
public IBaseEnum convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) {
public IBaseEnum convertToJavaData(ReadCellData<?> cellData,
ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) {
return this.getEnum(IBaseEnum.class, Convert.toStr(cellData.getData()));
}

/**
* 转换为 Excel 数据(写入 Excel)
*/
@Override
public WriteCellData<String> convertToExcelData(IBaseEnum<Integer> value, ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) {
public WriteCellData<String> convertToExcelData(IBaseEnum<Integer> value,
ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) {
if (null == value) {
return new WriteCellData<>(StringConstants.EMPTY);
}
Expand All @@ -72,10 +74,8 @@ public WriteCellData<String> convertToExcelData(IBaseEnum<Integer> value, ExcelC
/**
* 通过 value 获取枚举对象,获取不到时为 {@code null}
*
* @param enumType
* 枚举类型
* @param description
* 描述
* @param enumType 枚举类型
* @param description 描述
* @return 对应枚举 ,获取不到时为 {@code null}
*/
private IBaseEnum<Integer> getEnum(Class<?> enumType, String description) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ public class BaseEnumDeserializer extends JsonDeserializer<IBaseEnum> {
public static final BaseEnumDeserializer SERIALIZER_INSTANCE = new BaseEnumDeserializer();

@Override
public IBaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
throws IOException {
public IBaseEnum deserialize(JsonParser jsonParser,
DeserializationContext deserializationContext) throws IOException {
Class<?> targetClass = jsonParser.getCurrentValue().getClass();
String fieldName = jsonParser.getCurrentName();
String value = jsonParser.getText();
Expand All @@ -54,12 +54,9 @@ public IBaseEnum deserialize(JsonParser jsonParser, DeserializationContext deser
/**
* 通过某字段对应值获取枚举实例,获取不到时为 {@code null}
*
* @param targetClass
* 目标类型
* @param value
* 字段值
* @param fieldName
* 字段名
* @param targetClass 目标类型
* @param value 字段值
* @param fieldName 字段名
* @return 对应枚举实例 ,获取不到时为 {@code null}
*/
private IBaseEnum getEnum(Class<?> targetClass, String value, String fieldName) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@
public class SimpleDeserializersWrapper extends SimpleDeserializers {

@Override
public JsonDeserializer<?> findEnumDeserializer(Class<?> type, DeserializationConfig config,
BeanDescription beanDesc) throws JsonMappingException {
public JsonDeserializer<?> findEnumDeserializer(Class<?> type,
DeserializationConfig config,
BeanDescription beanDesc) throws JsonMappingException {
JsonDeserializer<?> deser = super.findEnumDeserializer(type, config, beanDesc);
if (null != deser) {
return deser;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,11 @@ public DataPermissionCurrentUser getCurrentUser() {
DataPermissionCurrentUser currentUser = new DataPermissionCurrentUser();
currentUser.setUserId(Convert.toStr(loginUser.getId()));
currentUser.setDeptId(Convert.toStr(loginUser.getDeptId()));
currentUser.setRoles(loginUser.getRoles().stream()
.map(r -> new DataPermissionCurrentUser.CurrentUserRole(Convert.toStr(r.getId()),
DataScope.valueOf(r.getDataScope().name())))
currentUser.setRoles(loginUser.getRoles()
.stream()
.map(r -> new DataPermissionCurrentUser.CurrentUserRole(Convert.toStr(r.getId()), DataScope.valueOf(r
.getDataScope()
.name())))
.collect(Collectors.toSet()));
return currentUser;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ public class MyBatisPlusMetaObjectHandler implements MetaObjectHandler {
/**
* 插入数据时填充
*
* @param metaObject
* 元对象
* @param metaObject 元对象
*/
@Override
public void insertFill(MetaObject metaObject) {
Expand Down Expand Up @@ -77,8 +76,7 @@ public void insertFill(MetaObject metaObject) {
/**
* 修改数据时填充
*
* @param metaObject
* 元对象
* @param metaObject 元对象
*/
@Override
public void updateFill(MetaObject metaObject) {
Expand Down Expand Up @@ -106,14 +104,10 @@ public void updateFill(MetaObject metaObject) {
/**
* 填充字段值
*
* @param metaObject
* 元数据对象
* @param fieldName
* 要填充的字段名
* @param fillFieldValue
* 要填充的字段值
* @param isOverride
* 如果字段值不为空,是否覆盖(true:覆盖;false:不覆盖)
* @param metaObject 元数据对象
* @param fieldName 要填充的字段名
* @param fillFieldValue 要填充的字段值
* @param isOverride 如果字段值不为空,是否覆盖(true:覆盖;false:不覆盖)
*/
private void fillFieldValue(MetaObject metaObject, String fieldName, Object fillFieldValue, boolean isOverride) {
if (metaObject.hasSetter(fieldName)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ public class CaptchaResp implements Serializable {
/**
* 验证码图片(Base64编码,带图片格式:data:image/gif;base64)
*/
@Schema(description = "验证码图片(Base64编码,带图片格式:data:image/gif;base64)",
example = "data:image/png;base64,iVBORw0KGgoAAAAN...")
@Schema(description = "验证码图片(Base64编码,带图片格式:data:image/gif;base64)", example = "data:image/png;base64,iVBORw0KGgoAAAAN...")
private String img;
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,8 @@ public class SecureUtils {
/**
* 公钥加密
*
* @param data
* 要加密的内容
* @param publicKey
* 公钥
* @param data 要加密的内容
* @param publicKey 公钥
* @return 公钥加密并 Base64 加密后的内容
*/
public static String encryptByRsaPublicKey(String data, String publicKey) {
Expand All @@ -51,8 +49,7 @@ public static String encryptByRsaPublicKey(String data, String publicKey) {
/**
* 私钥解密
*
* @param data
* 要解密的内容(Base64 加密过)
* @param data 要解密的内容(Base64 加密过)
* @return 解密后的内容
*/
public static String decryptByRsaPrivateKey(String data) {
Expand All @@ -64,10 +61,8 @@ public static String decryptByRsaPrivateKey(String data) {
/**
* 私钥解密
*
* @param data
* 要解密的内容(Base64 加密过)
* @param privateKey
* 私钥
* @param data 要解密的内容(Base64 加密过)
* @param privateKey 私钥
* @return 解密后的内容
*/
public static String decryptByRsaPrivateKey(String data, String privateKey) {
Expand All @@ -77,10 +72,8 @@ public static String decryptByRsaPrivateKey(String data, String privateKey) {
/**
* MD5 加密
*
* @param data
* 要加密的内容
* @param salt
* 盐
* @param data 要加密的内容
* @param salt 盐
* @return 加密后的内容
*/
public static String md5Salt(String data, String salt) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ public class LoginHelper {
/**
* 用户登录并缓存用户信息
*
* @param loginUser
* 登录用户信息
* @param loginUser 登录用户信息
* @return 令牌
*/
public static String login(LoginUser loginUser) {
Expand Down Expand Up @@ -93,8 +92,7 @@ public static LoginUser getLoginUser() {
/**
* 根据 Token 获取登录用户信息
*
* @param token
* 用户 Token
* @param token 用户 Token
* @return 登录用户信息
*/
public static LoginUser getLoginUser(String token) {
Expand Down Expand Up @@ -135,8 +133,7 @@ public static String getNickname() {
/**
* 获取登录用户昵称
*
* @param userId
* 登录用户 ID
* @param userId 登录用户 ID
* @return 登录用户昵称
*/
public static String getNickname(Long userId) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ public void add(LogRecord logRecord) {
LogDO logDO = new LogDO();
logDO.setDescription(logRecord.getDescription());
String module = logRecord.getModule();
logDO.setModule(
StrUtil.isNotBlank(module) ? logRecord.getModule().replace("API", StringConstants.EMPTY).trim() : null);
logDO.setModule(StrUtil.isNotBlank(module)
? logRecord.getModule().replace("API", StringConstants.EMPTY).trim()
: null);
logDO.setCreateTime(LocalDateTime.ofInstant(logRecord.getTimestamp(), ZoneId.systemDefault()));
logDO.setTimeTaken(logRecord.getTimeTaken().toMillis());
// 请求信息
Expand Down Expand Up @@ -105,16 +106,16 @@ public void add(LogRecord logRecord) {
logDO.setCreateUser(-1 != loginId ? loginId : null);
} else if (result.isSuccess() && requestUri.startsWith(SysConstants.LOGIN_URI)) {
AccountLoginReq loginReq = JSONUtil.toBean(requestBody, AccountLoginReq.class);
logDO.setCreateUser(
ExceptionUtils.exToNull(() -> userService.getByUsername(loginReq.getUsername()).getId()));
logDO.setCreateUser(ExceptionUtils.exToNull(() -> userService.getByUsername(loginReq.getUsername())
.getId()));
}
}
// 操作人
if (!requestUri.startsWith(SysConstants.LOGOUT_URI) && MapUtil.isNotEmpty(requestHeaderMap)
&& requestHeaderMap.containsKey(HttpHeaders.AUTHORIZATION)) {
if (!requestUri.startsWith(SysConstants.LOGOUT_URI) && MapUtil.isNotEmpty(requestHeaderMap) && requestHeaderMap
.containsKey(HttpHeaders.AUTHORIZATION)) {
String authorization = requestHeaderMap.get(HttpHeaders.AUTHORIZATION);
String token = authorization.replace(SaManager.getConfig().getTokenPrefix() + StringConstants.SPACE,
StringConstants.EMPTY);
String token = authorization.replace(SaManager.getConfig()
.getTokenPrefix() + StringConstants.SPACE, StringConstants.EMPTY);
logDO.setCreateUser(Convert.toLong(StpUtil.getLoginIdByToken(token)));
}
logMapper.insert(logDO);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ public interface LogMapper extends BaseMapper<LogDO> {
/**
* 查询仪表盘访问趋势信息
*
* @param days
* 日期数
* @param days 日期数
*
* @return 仪表盘访问趋势信息
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ public class DashboardGeoDistributionResp implements Serializable {
/**
* 地点 IP 统计信息
*/
@Schema(description = "地点 IP 统计信息",
example = "[{\"name\":\"中国北京北京市\",\"value\":1000},{\"name\":\"中国广东省深圳市\",\"value\": 500}]")
@Schema(description = "地点 IP 统计信息", example = "[{\"name\":\"中国北京北京市\",\"value\":1000},{\"name\":\"中国广东省深圳市\",\"value\": 500}]")
private List<Map<String, Object>> locationIpStatistics;
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ public interface DashboardService {
/**
* 查询访问趋势信息
*
* @param days
* 日期数
* @param days 日期数
* @return 访问趋势信息
*/
List<DashboardAccessTrendResp> listAccessTrend(Integer days);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,41 +37,34 @@ public interface LogService {
/**
* 分页查询操作日志列表
*
* @param query
* 查询条件
* @param pageQuery
* 分页查询条件
* @param query 查询条件
* @param pageQuery 分页查询条件
* @return 操作日志分页信息
*/
PageResp<OperationLogResp> page(OperationLogQuery query, PageQuery pageQuery);

/**
* 分页查询登录日志列表
*
* @param query
* 查询条件
* @param pageQuery
* 分页查询条件
* @param query 查询条件
* @param pageQuery 分页查询条件
* @return 登录日志分页信息
*/
PageResp<LoginLogResp> page(LoginLogQuery query, PageQuery pageQuery);

/**
* 分页查询系统日志列表
*
* @param query
* 查询条件
* @param pageQuery
* 分页查询条件
* @param query 查询条件
* @param pageQuery 分页查询条件
* @return 系统日志分页信息
*/
PageResp<SystemLogResp> page(SystemLogQuery query, PageQuery pageQuery);

/**
* 查看系统日志详情
*
* @param logId
* 日志 ID
* @param logId 日志 ID
* @return 系统日志详情
*/
SystemLogDetailResp get(Long logId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public DashboardTotalResp getTotal() {
Long todayPvCount = totalResp.getTodayPvCount();
Long yesterdayPvCount = totalResp.getYesterdayPvCount();
BigDecimal newPvCountFromYesterday = NumberUtil.sub(todayPvCount, yesterdayPvCount);
BigDecimal newPvFromYesterday = (0 == yesterdayPvCount) ? BigDecimal.valueOf(100)
BigDecimal newPvFromYesterday = (0 == yesterdayPvCount)
? BigDecimal.valueOf(100)
: NumberUtil.round(NumberUtil.mul(NumberUtil.div(newPvCountFromYesterday, yesterdayPvCount), 100), 1);
totalResp.setNewPvFromYesterday(newPvFromYesterday);
return totalResp;
Expand All @@ -78,7 +79,8 @@ public List<DashboardPopularModuleResp> listPopularModule() {
Long todayPvCount = popularModule.getTodayPvCount();
Long yesterdayPvCount = popularModule.getYesterdayPvCount();
BigDecimal newPvCountFromYesterday = NumberUtil.sub(todayPvCount, yesterdayPvCount);
BigDecimal newPvFromYesterday = (0 == yesterdayPvCount) ? BigDecimal.valueOf(100)
BigDecimal newPvFromYesterday = (0 == yesterdayPvCount)
? BigDecimal.valueOf(100)
: NumberUtil.round(NumberUtil.mul(NumberUtil.div(newPvCountFromYesterday, yesterdayPvCount), 100), 1);
popularModule.setNewPvFromYesterday(newPvFromYesterday);
}
Expand Down
Loading

0 comments on commit 35e3123

Please sign in to comment.