upd: 编码规范

This commit is contained in:
2025-04-09 19:46:43 +08:00
parent a320edadf1
commit 01f4d7ed72
15 changed files with 52 additions and 52 deletions
@@ -31,14 +31,14 @@ public class CaptchaController {
@ApiOperation("重置邮箱,发送验证码")
@PostMapping(value = "/sendResetEmailCaptcha")
public ResponseEntity<Object> sendResetEmailCaptcha(@RequestParam String email) {
emailService.sendCaptcha(email, CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey());
emailService.sendEmailCaptcha(email, CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey());
return new ResponseEntity<>(HttpStatus.OK);
}
@ApiOperation("重置密码,发送验证码")
@PostMapping(value = "/sendResetPasswordCaptcha")
public ResponseEntity<Object> sendResetPasswordCaptcha(@RequestParam String email) {
emailService.sendCaptcha(email, CodeEnum.EMAIL_RESET_PWD_CODE.getKey());
emailService.sendEmailCaptcha(email, CodeEnum.EMAIL_RESET_PWD_CODE.getKey());
return new ResponseEntity<>(HttpStatus.OK);
}
@@ -48,10 +48,10 @@ public class CaptchaController {
CodeBiEnum biEnum = CodeBiEnum.find(codeBi);
switch (Objects.requireNonNull(biEnum)) {
case ONE:
captchaService.checkCode(CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey(), email, code);
captchaService.checkCodeAvailable(CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey(), email, code);
break;
case TWO:
captchaService.checkCode(CodeEnum.EMAIL_RESET_PWD_CODE.getKey(), email, code);
captchaService.checkCodeAvailable(CodeEnum.EMAIL_RESET_PWD_CODE.getKey(), email, code);
break;
default:
break;
@@ -179,7 +179,7 @@ public class UserController {
if (!passwordEncoder.matches(password, user.getPassword())) {
throw new BadRequestException("密码错误");
}
verificationCodeService.checkCode(CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey(), resources.getEmail(), code);
verificationCodeService.checkCodeAvailable(CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey(), resources.getEmail(), code);
userService.updateEmailByUsername(user.getUsername(), resources.getEmail());
return new ResponseEntity<>(HttpStatus.OK);
}
@@ -27,13 +27,13 @@ public class EmailController {
@ApiOperation("查询配置")
@PostMapping(value = "/queryEmailConfig")
public ResponseEntity<EmailConfig> queryEmailConfig() {
return new ResponseEntity<>(emailService.getEmailConfig(), HttpStatus.OK);
return new ResponseEntity<>(emailService.describeEmailConfig(), HttpStatus.OK);
}
@ApiOperation("配置邮件")
@PostMapping(value = "/updateEmailConfig")
public ResponseEntity<Object> updateEmailConfig(@Validated @RequestBody EmailConfig emailConfig) throws Exception {
emailService.updateEmailConfigOnPassChange(emailConfig);
emailService.modifyEmailConfigOnPassChange(emailConfig);
return new ResponseEntity<>(HttpStatus.OK);
}
@@ -39,14 +39,14 @@ public class LocalStorageController {
@PreAuthorize("@el.check('storage:list')")
public ResponseEntity<PageResult<LocalStorage>> queryFile(QueryLocalStorageRequest criteria) {
Page<Object> page = new Page<>(criteria.getPage(), criteria.getSize());
return new ResponseEntity<>(localStorageService.queryLocalStoragePage(criteria, page), HttpStatus.OK);
return new ResponseEntity<>(localStorageService.describeLocalStoragePage(criteria, page), HttpStatus.OK);
}
@ApiOperation("导出数据")
@GetMapping(value = "/download")
@PreAuthorize("@el.check('storage:list')")
public void exportFile(HttpServletResponse response, QueryLocalStorageRequest criteria) throws IOException {
localStorageService.downloadExcel(localStorageService.selectLocalStorageByCriteria(criteria), response);
localStorageService.downloadExcel(localStorageService.describeLocalStorageList(criteria), response);
}
@ApiOperation("上传文件")
@@ -73,7 +73,7 @@ public class LocalStorageController {
@PutMapping
@PreAuthorize("@el.check('storage:edit')")
public ResponseEntity<Object> updateFile(@Validated @RequestBody LocalStorage resources) {
localStorageService.updateLocalStorageById(resources);
localStorageService.modifyLocalStorageById(resources);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
}
@@ -43,28 +43,28 @@ public class QiniuController {
@ApiOperation("查询七牛云存储配置")
@PostMapping(value = "/queryQiNiuConfig")
public ResponseEntity<QiniuConfig> queryQiNiuConfig() {
return new ResponseEntity<>(qiNiuConfigService.getConfig(), HttpStatus.OK);
return new ResponseEntity<>(qiNiuConfigService.describeQiniuConfig(), HttpStatus.OK);
}
@ApiOperation("配置七牛云存储")
@PostMapping(value = "/updateQiNiuConfig")
public ResponseEntity<Object> updateQiNiuConfig(@Validated @RequestBody QiniuConfig qiniuConfig) {
qiNiuConfigService.saveConfig(qiniuConfig);
qiNiuConfigService.updateType(qiniuConfig.getType());
qiNiuConfigService.saveQiniuConfig(qiniuConfig);
qiNiuConfigService.modifyQiniuConfigType(qiniuConfig.getType());
return new ResponseEntity<>(HttpStatus.OK);
}
@ApiOperation("导出数据")
@GetMapping(value = "/download")
public void exportQiNiu(HttpServletResponse response, QueryQiniuRequest criteria) throws IOException {
qiniuContentService.downloadExcel(qiniuContentService.selectQiniuContentByCriteria(criteria), response);
qiniuContentService.downloadExcel(qiniuContentService.describeQiniuContentList(criteria), response);
}
@ApiOperation("查询文件")
@GetMapping
public ResponseEntity<PageResult<QiniuContent>> queryQiNiu(QueryQiniuRequest criteria) {
Page<Object> page = new Page<>(criteria.getPage(), criteria.getSize());
return new ResponseEntity<>(qiniuContentService.queryQiniuContentPage(criteria, page), HttpStatus.OK);
return new ResponseEntity<>(qiniuContentService.describeQiniuContentPage(criteria, page), HttpStatus.OK);
}
@ApiOperation("上传文件")
@@ -89,7 +89,7 @@ public class QiniuController {
@GetMapping(value = "/download/{id}")
public ResponseEntity<Object> downloadQiNiu(@PathVariable Long id) {
Map<String, Object> map = new HashMap<>(1);
map.put("url", qiniuContentService.download(qiniuContentService.getById(id)));
map.put("url", qiniuContentService.createFilePreviewUrl(qiniuContentService.getById(id)));
return new ResponseEntity<>(map, HttpStatus.OK);
}
@@ -11,7 +11,7 @@ public interface CaptchaService {
* @param key /
* @return /
*/
SendEmailRequest renderCode(String email, String key);
SendEmailRequest renderCodeTemplate(String email, String key);
/**
@@ -20,5 +20,5 @@ public interface CaptchaService {
* @param code /
* @param key /
*/
void checkCode(String key, String email, String code);
void checkCodeAvailable(String key, String email, String code);
}
@@ -14,14 +14,14 @@ public interface EmailService extends IService<EmailConfig> {
* @return /
* @throws Exception /
*/
void updateEmailConfigOnPassChange(EmailConfig emailConfig) throws Exception;
void modifyEmailConfigOnPassChange(EmailConfig emailConfig) throws Exception;
/**
* 查询配置
*
* @return EmailConfig 邮件配置
*/
EmailConfig getEmailConfig();
EmailConfig describeEmailConfig();
/**
* 发送邮件
@@ -36,5 +36,5 @@ public interface EmailService extends IService<EmailConfig> {
* @param email 邮箱地址
* @param key 类型
*/
void sendCaptcha(String email, String key);
void sendEmailCaptcha(String email, String key);
}
@@ -20,7 +20,7 @@ public interface LocalStorageService extends IService<LocalStorage> {
* @param page 分页参数
* @return /
*/
PageResult<LocalStorage> queryLocalStoragePage(QueryLocalStorageRequest criteria, Page<Object> page);
PageResult<LocalStorage> describeLocalStoragePage(QueryLocalStorageRequest criteria, Page<Object> page);
/**
* 查询全部数据
@@ -28,7 +28,7 @@ public interface LocalStorageService extends IService<LocalStorage> {
* @param criteria 条件
* @return /
*/
List<LocalStorage> selectLocalStorageByCriteria(QueryLocalStorageRequest criteria);
List<LocalStorage> describeLocalStorageList(QueryLocalStorageRequest criteria);
/**
* 上传
@@ -44,7 +44,7 @@ public interface LocalStorageService extends IService<LocalStorage> {
*
* @param resources 文件信息
*/
void updateLocalStorageById(LocalStorage resources);
void modifyLocalStorageById(LocalStorage resources);
/**
* 多选删除
@@ -11,19 +11,19 @@ public interface QiNiuConfigService extends IService<QiniuConfig> {
*
* @return QiniuConfig
*/
QiniuConfig getConfig();
QiniuConfig describeQiniuConfig();
/**
* 保存
*
* @param type 类型
*/
void saveConfig(QiniuConfig type);
void saveQiniuConfig(QiniuConfig type);
/**
* 更新
*
* @param type 类型
*/
void updateType(String type);
void modifyQiniuConfigType(String type);
}
@@ -20,7 +20,7 @@ public interface QiniuContentService extends IService<QiniuContent> {
* @param page 分页参数
* @return /
*/
PageResult<QiniuContent> queryQiniuContentPage(QueryQiniuRequest criteria, Page<Object> page);
PageResult<QiniuContent> describeQiniuContentPage(QueryQiniuRequest criteria, Page<Object> page);
/**
* 查询全部
@@ -28,7 +28,7 @@ public interface QiniuContentService extends IService<QiniuContent> {
* @param criteria 条件
* @return /
*/
List<QiniuContent> selectQiniuContentByCriteria(QueryQiniuRequest criteria);
List<QiniuContent> describeQiniuContentList(QueryQiniuRequest criteria);
/**
* 上传文件
@@ -39,12 +39,12 @@ public interface QiniuContentService extends IService<QiniuContent> {
QiniuContent uploadFile(MultipartFile file);
/**
* 下载文件
* 创建文件预览链接
*
* @param content 文件信息
* @return String
*/
String download(QiniuContent content);
String createFilePreviewUrl(QiniuContent content);
/**
* 同步数据
@@ -25,7 +25,7 @@ public class CaptchaServiceImpl implements CaptchaService {
@Override
@Transactional(rollbackFor = Exception.class)
public SendEmailRequest renderCode(String email, String key) {
public SendEmailRequest renderCodeTemplate(String email, String key) {
SendEmailRequest sendEmailRequest;
String content;
String redisKey = key + email;
@@ -49,7 +49,7 @@ public class CaptchaServiceImpl implements CaptchaService {
}
@Override
public void checkCode(String key, String email, String code) {
public void checkCodeAvailable(String key, String email, String code) {
String value = redisHelper.get(key + email, String.class);
if (value == null || !value.equals(code)) {
throw new BadRequestException("无效验证码");
@@ -31,8 +31,8 @@ public class EmailServiceImpl extends ServiceImpl<EmailConfigMapper, EmailConfig
@Override
@CachePut(key = "'config'")
@Transactional(rollbackFor = Exception.class)
public void updateEmailConfigOnPassChange(EmailConfig emailConfig) throws Exception {
EmailConfig localConfig = emailService.getEmailConfig();
public void modifyEmailConfigOnPassChange(EmailConfig emailConfig) throws Exception {
EmailConfig localConfig = emailService.describeEmailConfig();
if (!emailConfig.getPassword().equals(localConfig.getPassword())) {
// 对称加密
emailConfig.setPassword(DesEncryptUtil.desEncrypt(emailConfig.getPassword()));
@@ -43,7 +43,7 @@ public class EmailServiceImpl extends ServiceImpl<EmailConfigMapper, EmailConfig
@Override
@Cacheable(key = "'config'")
public EmailConfig getEmailConfig() {
public EmailConfig describeEmailConfig() {
EmailConfig emailConfig = getById(1L);
return emailConfig == null ? new EmailConfig() : emailConfig;
}
@@ -51,7 +51,7 @@ public class EmailServiceImpl extends ServiceImpl<EmailConfigMapper, EmailConfig
@Override
@Transactional(rollbackFor = Exception.class)
public void sendEmail(SendEmailRequest sendEmailRequest) {
EmailConfig emailConfig = emailService.getEmailConfig();
EmailConfig emailConfig = emailService.describeEmailConfig();
if (emailConfig.getId() == null) {
throw new BadRequestException("请先配置,再操作");
}
@@ -95,7 +95,7 @@ public class EmailServiceImpl extends ServiceImpl<EmailConfigMapper, EmailConfig
}
@Override
public void sendCaptcha(String email, String key) {
emailService.sendEmail(captchaService.renderCode(email, CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey()));
public void sendEmailCaptcha(String email, String key) {
emailService.sendEmail(captchaService.renderCodeTemplate(email, CodeEnum.EMAIL_RESET_EMAIL_CODE.getKey()));
}
}
@@ -34,12 +34,12 @@ public class LocalStorageServiceImpl extends ServiceImpl<LocalStorageMapper, Loc
private final FileProperties properties;
@Override
public PageResult<LocalStorage> queryLocalStoragePage(QueryLocalStorageRequest criteria, Page<Object> page) {
public PageResult<LocalStorage> describeLocalStoragePage(QueryLocalStorageRequest criteria, Page<Object> page) {
return PageUtil.toPage(localStorageMapper.queryLocalStoragePageByArgs(criteria, page));
}
@Override
public List<LocalStorage> selectLocalStorageByCriteria(QueryLocalStorageRequest criteria) {
public List<LocalStorage> describeLocalStorageList(QueryLocalStorageRequest criteria) {
return localStorageMapper.queryLocalStoragePageByArgs(criteria, PageUtil.getCount(localStorageMapper)).getRecords();
}
@@ -75,7 +75,7 @@ public class LocalStorageServiceImpl extends ServiceImpl<LocalStorageMapper, Loc
@Override
@Transactional(rollbackFor = Exception.class)
public void updateLocalStorageById(LocalStorage resources) {
public void modifyLocalStorageById(LocalStorage resources) {
LocalStorage localStorage = getById(resources.getId());
localStorage.copy(resources);
saveOrUpdate(localStorage);
@@ -20,7 +20,7 @@ import org.springframework.transaction.annotation.Transactional;
public class QiNiuConfigServiceImpl extends ServiceImpl<QiniuConfigMapper, QiniuConfig> implements QiNiuConfigService {
@Override
@Cacheable(key = "'config'")
public QiniuConfig getConfig() {
public QiniuConfig describeQiniuConfig() {
QiniuConfig qiniuConfig = getById(1L);
return qiniuConfig == null ? new QiniuConfig() : qiniuConfig;
}
@@ -28,7 +28,7 @@ public class QiNiuConfigServiceImpl extends ServiceImpl<QiniuConfigMapper, Qiniu
@Override
@CacheEvict(key = "'config'")
@Transactional(rollbackFor = Exception.class)
public void saveConfig(QiniuConfig qiniuConfig) {
public void saveQiniuConfig(QiniuConfig qiniuConfig) {
qiniuConfig.setId(1L);
if (!(qiniuConfig.getHost().toLowerCase().startsWith(TransferProtocolConst.PREFIX_HTTP) || qiniuConfig.getHost().toLowerCase().startsWith(TransferProtocolConst.PREFIX_HTTPS))) {
throw new BadRequestException(TransferProtocolConst.PREFIX_HTTPS_BAD_REQUEST);
@@ -39,7 +39,7 @@ public class QiNiuConfigServiceImpl extends ServiceImpl<QiniuConfigMapper, Qiniu
@Override
@CacheEvict(key = "'config'")
@Transactional(rollbackFor = Exception.class)
public void updateType(String type) {
public void modifyQiniuConfigType(String type) {
QiniuConfig qiniuConfig = getById(1L);
qiniuConfig.setType(type);
saveOrUpdate(qiniuConfig);
@@ -46,12 +46,12 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin
private Long maxSize;
@Override
public PageResult<QiniuContent> queryQiniuContentPage(QueryQiniuRequest criteria, Page<Object> page) {
public PageResult<QiniuContent> describeQiniuContentPage(QueryQiniuRequest criteria, Page<Object> page) {
return PageUtil.toPage(qiniuContentMapper.queryQiniuContentPageByArgs(criteria, page));
}
@Override
public List<QiniuContent> selectQiniuContentByCriteria(QueryQiniuRequest criteria) {
public List<QiniuContent> describeQiniuContentList(QueryQiniuRequest criteria) {
return qiniuContentMapper.queryQiniuContentPageByArgs(criteria, PageUtil.getCount(qiniuContentMapper)).getRecords();
}
@@ -59,7 +59,7 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin
@Transactional(rollbackFor = Exception.class)
public QiniuContent uploadFile(MultipartFile file) {
FileUtil.checkSize(maxSize, file.getSize());
QiniuConfig qiniuConfig = qiNiuConfigService.getConfig();
QiniuConfig qiniuConfig = qiNiuConfigService.describeQiniuConfig();
if (qiniuConfig.getId() == null) {
throw new BadRequestException("请先添加相应配置,再操作");
}
@@ -96,8 +96,8 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin
}
@Override
public String download(QiniuContent content) {
QiniuConfig qiniuConfig = qiNiuConfigService.getConfig();
public String createFilePreviewUrl(QiniuContent content) {
QiniuConfig qiniuConfig = qiNiuConfigService.describeQiniuConfig();
String finalUrl;
String type = "公开";
if (type.equals(content.getType())) {
@@ -114,7 +114,7 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin
@Override
@Transactional(rollbackFor = Exception.class)
public void deleteFileById(Long id) {
QiniuConfig qiniuConfig = qiNiuConfigService.getConfig();
QiniuConfig qiniuConfig = qiNiuConfigService.describeQiniuConfig();
QiniuContent qiniuContent = qiniuContentMapper.selectById(id);
if (qiniuContent == null) {
throw new BadRequestException("文件不存在");
@@ -135,7 +135,7 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin
@Override
@Transactional(rollbackFor = Exception.class)
public void synchronize() {
QiniuConfig qiniuConfig = qiNiuConfigService.getConfig();
QiniuConfig qiniuConfig = qiNiuConfigService.describeQiniuConfig();
if (qiniuConfig.getId() == null) {
throw new BadRequestException("请先添加相应配置,再操作");
}