zayac/zayac-admin
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style: 优化后端部分参数模型命名

Browse Source 
模型命名规则遵循：名词+动作+后缀，例如：UserPasswordUpdateRequest
This commit is contained in:
Charles7c 2023-10-25 21:27:39 +08:00
parent 17b169eb0e
commit 51f552892c
15 changed files with 58 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/interceptor/LogInterceptor.java
View File

@ -50,7 +50,7 @@ import cn.hutool.json.JSONArray;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import top.charles7c.cnadmin.auth.model.request.LoginRequest;
import top.charles7c.cnadmin.auth.model.request.AccountLoginRequest;
import top.charles7c.cnadmin.common.constant.StringConsts;
import top.charles7c.cnadmin.common.constant.SysConsts;
import top.charles7c.cnadmin.common.model.dto.LogContext;
@ -225,7 +225,7 @@ public class LogInterceptor implements HandlerInterceptor {
logDO.setCreateUser(null);
}
if (null == logDO.getCreateUser() && SysConsts.LOGIN_URI.equals(requestURI)) {
LoginRequest loginRequest = JSONUtil.toBean(requestBody, LoginRequest.class);
AccountLoginRequest loginRequest = JSONUtil.toBean(requestBody, AccountLoginRequest.class);
logDO.setCreateUser(
ExceptionUtils.exToNull(() -> userService.getByUsername(loginRequest.getUsername()).getId()));
}

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/auth/model/request/LoginRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/auth/model/request/AccountLoginRequest.java
View File

@ -25,14 +25,14 @@ import lombok.Data;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* 登录信息
* 账号登录信息
*
* @author Charles7c
* @since 2022/12/21 20:43
*/
@Data
@Schema(description = "登录信息")
public class LoginRequest implements Serializable {
@Schema(description = "账号登录信息")
public class AccountLoginRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/ResetOptionValueRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/OptionResetValueRequest.java
View File

@ -26,14 +26,14 @@ import lombok.Data;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* 重置参数信息
* 参数重置信息
*
* @author Bull-BCLS
* @since 2023/9/21 23:10
*/
@Data
@Schema(description = "重置参数信息")
public class ResetOptionValueRequest implements Serializable {
@Schema(description = "参数重置信息")
public class OptionResetValueRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UpdateBasicInfoRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UserBasicInfoUpdateRequest.java
View File

@ -30,14 +30,14 @@ import top.charles7c.cnadmin.common.constant.RegexConsts;
import top.charles7c.cnadmin.common.enums.GenderEnum;
/**
* 修改基础信息
* 用户基础信息修改信息
*
* @author Charles7c
* @since 2023/1/7 23:08
*/
@Data
@Schema(description = "修改基础信息")
public class UpdateBasicInfoRequest implements Serializable {
@Schema(description = "用户基础信息修改信息")
public class UserBasicInfoUpdateRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UpdateEmailRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UserEmailUpdateRequest.java
View File

@ -30,14 +30,14 @@ import org.hibernate.validator.constraints.Length;
import top.charles7c.cnadmin.common.constant.RegexConsts;
/**
* 修改邮箱信息
* 用户邮箱修改信息
*
* @author Charles7c
* @since 2023/1/12 20:18
*/
@Data
@Schema(description = "修改邮箱信息")
public class UpdateEmailRequest implements Serializable {
@Schema(description = "用户邮箱修改信息")
public class UserEmailUpdateRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UpdatePasswordRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UserPasswordUpdateRequest.java
View File

@ -25,14 +25,14 @@ import lombok.Data;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* 修改密码信息
* 用户密码修改信息
*
* @author Charles7c
* @since 2023/1/9 23:28
*/
@Data
@Schema(description = "修改密码信息")
public class UpdatePasswordRequest implements Serializable {
@Schema(description = "用户密码修改信息")
public class UserPasswordUpdateRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UpdateUserRoleRequest.java → continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/UserRoleUpdateRequest.java
View File

@ -26,14 +26,14 @@ import lombok.Data;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* 修改用户角色信息
* 用户角色修改信息
*
* @author Charles7c
* @since 2023/2/24 23:05
*/
@Data
@Schema(description = "修改用户角色信息")
public class UpdateUserRoleRequest implements Serializable {
@Schema(description = "用户角色修改信息")
public class UserRoleUpdateRequest implements Serializable {
private static final long serialVersionUID = 1L;

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/OptionService.java
View File

@ -20,7 +20,7 @@ import java.util.List;
import top.charles7c.cnadmin.system.model.query.OptionQuery;
import top.charles7c.cnadmin.system.model.request.OptionRequest;
import top.charles7c.cnadmin.system.model.request.ResetOptionValueRequest;
import top.charles7c.cnadmin.system.model.request.OptionResetValueRequest;
import top.charles7c.cnadmin.system.model.vo.OptionVO;
/**
@ -52,7 +52,7 @@ public interface OptionService {
* 重置参数
*
* @param request
* 重置参数信息
* 重置信息
*/
void resetValue(ResetOptionValueRequest request);
void resetValue(OptionResetValueRequest request);
}

12
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/UserService.java
View File

@ -23,9 +23,9 @@ import org.springframework.web.multipart.MultipartFile;
import top.charles7c.cnadmin.common.base.BaseService;
import top.charles7c.cnadmin.system.model.entity.UserDO;
import top.charles7c.cnadmin.system.model.query.UserQuery;
import top.charles7c.cnadmin.system.model.request.UpdateBasicInfoRequest;
import top.charles7c.cnadmin.system.model.request.UpdateUserRoleRequest;
import top.charles7c.cnadmin.system.model.request.UserBasicInfoUpdateRequest;
import top.charles7c.cnadmin.system.model.request.UserRequest;
import top.charles7c.cnadmin.system.model.request.UserRoleUpdateRequest;
import top.charles7c.cnadmin.system.model.vo.UserDetailVO;
import top.charles7c.cnadmin.system.model.vo.UserVO;
@ -60,12 +60,12 @@ public interface UserService extends BaseService<UserVO, UserDetailVO, UserQuery
/**
* 修改基础信息
*
* @param request
* @param updateRequest
* 修改信息
* @param id
* ID
*/
void updateBasicInfo(UpdateBasicInfoRequest request, Long id);
void updateBasicInfo(UserBasicInfoUpdateRequest updateRequest, Long id);
/**
* 修改密码
@ -102,12 +102,12 @@ public interface UserService extends BaseService<UserVO, UserDetailVO, UserQuery
/**
* 修改角色
*
* @param request
* @param updateRequest
* 修改信息
* @param id
* ID
*/
void updateRole(UpdateUserRoleRequest request, Long id);
void updateRole(UserRoleUpdateRequest updateRequest, Long id);
/**
* 根据用户名查询

4
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/impl/OptionServiceImpl.java
View File

@ -32,7 +32,7 @@ import top.charles7c.cnadmin.system.mapper.OptionMapper;
import top.charles7c.cnadmin.system.model.entity.OptionDO;
import top.charles7c.cnadmin.system.model.query.OptionQuery;
import top.charles7c.cnadmin.system.model.request.OptionRequest;
import top.charles7c.cnadmin.system.model.request.ResetOptionValueRequest;
import top.charles7c.cnadmin.system.model.request.OptionResetValueRequest;
import top.charles7c.cnadmin.system.model.vo.OptionVO;
import top.charles7c.cnadmin.system.service.OptionService;
@ -62,7 +62,7 @@ public class OptionServiceImpl implements OptionService {
@Override
@CacheEvict(allEntries = true)
public void resetValue(ResetOptionValueRequest request) {
public void resetValue(OptionResetValueRequest request) {
baseMapper.lambdaUpdate().set(OptionDO::getValue, null).in(OptionDO::getCode, request.getCode()).update();
}
}

14
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/impl/UserServiceImpl.java
View File

@ -52,9 +52,9 @@ import top.charles7c.cnadmin.common.util.validate.CheckUtils;
import top.charles7c.cnadmin.system.mapper.UserMapper;
import top.charles7c.cnadmin.system.model.entity.UserDO;
import top.charles7c.cnadmin.system.model.query.UserQuery;
import top.charles7c.cnadmin.system.model.request.UpdateBasicInfoRequest;
import top.charles7c.cnadmin.system.model.request.UpdateUserRoleRequest;
import top.charles7c.cnadmin.system.model.request.UserBasicInfoUpdateRequest;
import top.charles7c.cnadmin.system.model.request.UserRequest;
import top.charles7c.cnadmin.system.model.request.UserRoleUpdateRequest;
import top.charles7c.cnadmin.system.model.vo.UserDetailVO;
import top.charles7c.cnadmin.system.model.vo.UserVO;
import top.charles7c.cnadmin.system.service.DeptService;
@ -189,10 +189,10 @@ public class UserServiceImpl extends BaseServiceImpl<UserMapper, UserDO, UserVO,
@Override
@Transactional(rollbackFor = Exception.class)
public void updateBasicInfo(UpdateBasicInfoRequest request, Long id) {
public void updateBasicInfo(UserBasicInfoUpdateRequest updateRequest, Long id) {
super.getById(id);
baseMapper.lambdaUpdate().set(UserDO::getNickname, request.getNickname())
.set(UserDO::getGender, request.getGender()).eq(UserDO::getId, id).update();
baseMapper.lambdaUpdate().set(UserDO::getNickname, updateRequest.getNickname())
.set(UserDO::getGender, updateRequest.getGender()).eq(UserDO::getId, id).update();
}
@Override
@ -233,10 +233,10 @@ public class UserServiceImpl extends BaseServiceImpl<UserMapper, UserDO, UserVO,
@Override
@Transactional(rollbackFor = Exception.class)
public void updateRole(UpdateUserRoleRequest request, Long id) {
public void updateRole(UserRoleUpdateRequest updateRequest, Long id) {
super.getById(id);
// 保存用户和角色关联
userRoleService.save(request.getRoleIds(), id);
userRoleService.save(updateRequest.getRoleIds(), id);
}
@Override

4
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/auth/AuthController.java
View File

@ -32,8 +32,8 @@ import cn.dev33.satoken.annotation.SaIgnore;
import cn.dev33.satoken.stp.StpUtil;
import cn.hutool.core.bean.BeanUtil;
import top.charles7c.cnadmin.auth.model.request.AccountLoginRequest;
import top.charles7c.cnadmin.auth.model.request.EmailLoginRequest;
import top.charles7c.cnadmin.auth.model.request.LoginRequest;
import top.charles7c.cnadmin.auth.model.vo.LoginVO;
import top.charles7c.cnadmin.auth.model.vo.RouteVO;
import top.charles7c.cnadmin.auth.model.vo.UserInfoVO;
@ -68,7 +68,7 @@ public class AuthController {
@SaIgnore
@Operation(summary = "账号登录", description = "根据账号和密码进行登录认证")
@PostMapping("/account")
public LoginVO accountLogin(@Validated @RequestBody LoginRequest loginRequest) {
public LoginVO accountLogin(@Validated @RequestBody AccountLoginRequest loginRequest) {
String captchaKey = RedisUtils.formatKey(CacheConsts.CAPTCHA_KEY_PREFIX, loginRequest.getUuid());
String captcha = RedisUtils.getCacheObject(captchaKey);
ValidationUtils.throwIfBlank(captcha, "验证码已失效");

4
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/system/OptionController.java
View File

@ -30,7 +30,7 @@ import cn.dev33.satoken.annotation.SaCheckPermission;
import top.charles7c.cnadmin.system.model.query.OptionQuery;
import top.charles7c.cnadmin.system.model.request.OptionRequest;
import top.charles7c.cnadmin.system.model.request.ResetOptionValueRequest;
import top.charles7c.cnadmin.system.model.request.OptionResetValueRequest;
import top.charles7c.cnadmin.system.model.vo.OptionVO;
import top.charles7c.cnadmin.system.service.OptionService;
@ -65,7 +65,7 @@ public class OptionController {
@Operation(summary = "重置参数", description = "重置参数")
@SaCheckPermission("system:config:reset")
@PatchMapping("/value")
public void resetValue(@Validated @RequestBody ResetOptionValueRequest request) {
public void resetValue(@Validated @RequestBody OptionResetValueRequest request) {
optionService.resetValue(request);
}
}

26
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/system/UserCenterController.java
View File

@ -46,9 +46,9 @@ import top.charles7c.cnadmin.common.util.SecureUtils;
import top.charles7c.cnadmin.common.util.helper.LoginHelper;
import top.charles7c.cnadmin.common.util.validate.ValidationUtils;
import top.charles7c.cnadmin.system.model.entity.UserSocialDO;
import top.charles7c.cnadmin.system.model.request.UpdateBasicInfoRequest;
import top.charles7c.cnadmin.system.model.request.UpdateEmailRequest;
import top.charles7c.cnadmin.system.model.request.UpdatePasswordRequest;
import top.charles7c.cnadmin.system.model.request.UserBasicInfoUpdateRequest;
import top.charles7c.cnadmin.system.model.request.UserEmailUpdateRequest;
import top.charles7c.cnadmin.system.model.request.UserPasswordUpdateRequest;
import top.charles7c.cnadmin.system.model.vo.AvatarVO;
import top.charles7c.cnadmin.system.model.vo.UserSocialBindVO;
import top.charles7c.cnadmin.system.service.UserService;
@ -86,19 +86,19 @@ public class UserCenterController {
@Operation(summary = "修改基础信息", description = "修改用户基础信息")
@PatchMapping("/basic/info")
public R updateBasicInfo(@Validated @RequestBody UpdateBasicInfoRequest updateBasicInfoRequest) {
userService.updateBasicInfo(updateBasicInfoRequest, LoginHelper.getUserId());
public R updateBasicInfo(@Validated @RequestBody UserBasicInfoUpdateRequest updateRequest) {
userService.updateBasicInfo(updateRequest, LoginHelper.getUserId());
return R.ok("修改成功");
}
@Operation(summary = "修改密码", description = "修改用户登录密码")
@PatchMapping("/password")
public R updatePassword(@Validated @RequestBody UpdatePasswordRequest updatePasswordRequest) {
public R updatePassword(@Validated @RequestBody UserPasswordUpdateRequest updateRequest) {
String rawOldPassword =
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updatePasswordRequest.getOldPassword()));
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updateRequest.getOldPassword()));
ValidationUtils.throwIfNull(rawOldPassword, "当前密码解密失败");
String rawNewPassword =
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updatePasswordRequest.getNewPassword()));
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updateRequest.getNewPassword()));
ValidationUtils.throwIfNull(rawNewPassword, "新密码解密失败");
ValidationUtils.throwIf(!ReUtil.isMatch(RegexConsts.PASSWORD, rawNewPassword),
"密码长度为 6 到 32 位，可以包含字母、数字、下划线，特殊字符，同时包含字母和数字");
@ -108,16 +108,16 @@ public class UserCenterController {
@Operation(summary = "修改邮箱", description = "修改用户邮箱")
@PatchMapping("/email")
public R updateEmail(@Validated @RequestBody UpdateEmailRequest updateEmailRequest) {
public R updateEmail(@Validated @RequestBody UserEmailUpdateRequest updateRequest) {
String rawCurrentPassword =
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updateEmailRequest.getCurrentPassword()));
ExceptionUtils.exToNull(() -> SecureUtils.decryptByRsaPrivateKey(updateRequest.getCurrentPassword()));
ValidationUtils.throwIfBlank(rawCurrentPassword, "当前密码解密失败");
String captchaKey = RedisUtils.formatKey(CacheConsts.CAPTCHA_KEY_PREFIX, updateEmailRequest.getNewEmail());
String captchaKey = RedisUtils.formatKey(CacheConsts.CAPTCHA_KEY_PREFIX, updateRequest.getNewEmail());
String captcha = RedisUtils.getCacheObject(captchaKey);
ValidationUtils.throwIfBlank(captcha, "验证码已失效");
ValidationUtils.throwIfNotEqualIgnoreCase(updateEmailRequest.getCaptcha(), captcha, "验证码错误");
ValidationUtils.throwIfNotEqualIgnoreCase(updateRequest.getCaptcha(), captcha, "验证码错误");
RedisUtils.deleteCacheObject(captchaKey);
userService.updateEmail(updateEmailRequest.getNewEmail(), rawCurrentPassword, LoginHelper.getUserId());
userService.updateEmail(updateRequest.getNewEmail(), rawCurrentPassword, LoginHelper.getUserId());
return R.ok("修改成功");
}

6
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/system/UserController.java
View File

@ -35,8 +35,8 @@ import top.charles7c.cnadmin.common.base.ValidateGroup;
import top.charles7c.cnadmin.common.constant.SysConsts;
import top.charles7c.cnadmin.common.model.vo.R;
import top.charles7c.cnadmin.system.model.query.UserQuery;
import top.charles7c.cnadmin.system.model.request.UpdateUserRoleRequest;
import top.charles7c.cnadmin.system.model.request.UserRequest;
import top.charles7c.cnadmin.system.model.request.UserRoleUpdateRequest;
import top.charles7c.cnadmin.system.model.vo.UserDetailVO;
import top.charles7c.cnadmin.system.model.vo.UserVO;
import top.charles7c.cnadmin.system.service.UserService;
@ -73,8 +73,8 @@ public class UserController extends BaseController<UserService, UserVO, UserDeta
@Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
@SaCheckPermission("system:user:role:update")
@PatchMapping("/{id}/role")
public R updateRole(@Validated @RequestBody UpdateUserRoleRequest request, @PathVariable Long id) {
baseService.updateRole(request, id);
public R updateRole(@Validated @RequestBody UserRoleUpdateRequest updateRequest, @PathVariable Long id) {
baseService.updateRole(updateRequest, id);
return R.ok("分配成功");
}
}