upd: 编码规范

2025-04-09 19:05:50 +08:00
parent 7fd6bd4e91
commit d9233e1d67
15 changed files with 19 additions and 88 deletions
@@ -23,7 +23,7 @@ public class InitialActiveJobApplicationRunner implements ApplicationRunner {
     */
    @Override
    public void run(ApplicationArguments applicationArguments) {
-        List<QuartzJob> quartzJobs = quartzJobMapper.selectActiveQuartzJob();
+        List<QuartzJob> quartzJobs = quartzJobMapper.queryActiveQuartzJob();
        quartzJobs.forEach(quartzManage::addJob);
        log.info("Timing task injection complete");
    }
@@ -11,7 +11,7 @@ import java.util.List;

@Mapper
 public interface QuartzJobMapper extends BaseMapper<QuartzJob> {
-    IPage<QuartzJob> queryQuartzJobPage(@Param("criteria") QueryQuartzJobRequest criteria, Page<Object> page);
+    IPage<QuartzJob> queryQuartzJobPageByArgs(@Param("criteria") QueryQuartzJobRequest criteria, Page<Object> page);

-    List<QuartzJob> selectActiveQuartzJob();
+    List<QuartzJob> queryActiveQuartzJob();
 }
@@ -43,7 +43,7 @@ public class QuartzJobServiceImpl extends ServiceImpl<QuartzJobMapper, QuartzJob

    @Override
    public PageResult<QuartzJob> queryJobPage(QueryQuartzJobRequest criteria, Page<Object> page) {
-        return PageUtil.toPage(quartzJobMapper.queryQuartzJobPage(criteria, page));
+        return PageUtil.toPage(quartzJobMapper.queryQuartzJobPageByArgs(criteria, page));
    }

    @Override
@@ -53,7 +53,7 @@ public class QuartzJobServiceImpl extends ServiceImpl<QuartzJobMapper, QuartzJob

    @Override
    public List<QuartzJob> selectJobByCriteria(QueryQuartzJobRequest criteria) {
-        return quartzJobMapper.queryQuartzJobPage(criteria, PageUtil.getCount(quartzJobMapper)).getRecords();
+        return quartzJobMapper.queryQuartzJobPageByArgs(criteria, PageUtil.getCount(quartzJobMapper)).getRecords();
    }

    @Override
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
 <mapper namespace="cn.odboy.application.job.mapper.QuartzJobMapper">
-    <select id="queryQuartzJobPage" resultType="cn.odboy.model.job.domain.QuartzJob">
+    <select id="queryQuartzJobPageByArgs" resultType="cn.odboy.model.job.domain.QuartzJob">
        SELECT
        *
        FROM sys_quartz_job
@@ -15,7 +15,7 @@
        </where>
        ORDER BY id DESC
    </select>
-    <select id="selectActiveQuartzJob" resultType="cn.odboy.model.job.domain.QuartzJob">
+    <select id="queryActiveQuartzJob" resultType="cn.odboy.model.job.domain.QuartzJob">
        SELECT *
        FROM sys_quartz_job
        WHERE is_pause = 0
@@ -110,6 +110,6 @@ public class SpringSecurityConfig {
    }

    private TokenConfigurer securityConfigurerAdapter() {
-        return new TokenConfigurer(tokenProvider, securityProperties, onlineUserService);
+        return new TokenConfigurer(tokenProvider, onlineUserService);
    }
 }
@@ -103,7 +103,7 @@ public class UserController {
        checkLevel(resources);
        // 默认密码 123456
        resources.setPassword(passwordEncoder.encode("123456"));
-        userService.saveUser(resources);
+        userService.createUser(resources);
        return new ResponseEntity<>(HttpStatus.CREATED);
    }

@@ -27,7 +27,7 @@ public interface UserService extends IService<User> {
     *
     * @param resources /
     */
-    void saveUser(User resources);
+    void createUser(User resources);

    /**
     * 编辑用户
@@ -79,7 +79,7 @@ public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements Us

    @Override
    @Transactional(rollbackFor = Exception.class)
-    public void saveUser(User resources) {
+    public void createUser(User resources) {
        resources.setDeptId(resources.getDept().getId());
        if (userMapper.getUserByUsername(resources.getUsername()) != null) {
            throw new EntityExistException(User.class, "username", resources.getUsername());
@@ -10,5 +10,5 @@ import org.apache.ibatis.annotations.Param;

@Mapper
 public interface LocalStorageMapper extends BaseMapper<LocalStorage> {
-    IPage<LocalStorage> queryLocalStoragePage(@Param("criteria") QueryLocalStorageRequest criteria, Page<Object> page);
+    IPage<LocalStorage> queryLocalStoragePageByArgs(@Param("criteria") QueryLocalStorageRequest criteria, Page<Object> page);
 }
@@ -12,6 +12,5 @@ import org.apache.ibatis.annotations.Param;
@Mapper
 public interface QiniuContentMapper extends BaseMapper<QiniuContent> {
    QiniuContent getQiniuContentByName(@Param("name") String name);
-
-    IPage<QiniuContent> queryQiniuContentPage(@Param("criteria") QueryQiniuRequest criteria, Page<Object> page);
+    IPage<QiniuContent> queryQiniuContentPageByArgs(@Param("criteria") QueryQiniuRequest criteria, Page<Object> page);
 }
@@ -35,12 +35,12 @@ public class LocalStorageServiceImpl extends ServiceImpl<LocalStorageMapper, Loc

    @Override
    public PageResult<LocalStorage> queryLocalStoragePage(QueryLocalStorageRequest criteria, Page<Object> page) {
-        return PageUtil.toPage(localStorageMapper.queryLocalStoragePage(criteria, page));
+        return PageUtil.toPage(localStorageMapper.queryLocalStoragePageByArgs(criteria, page));
    }

    @Override
    public List<LocalStorage> selectLocalStorageByCriteria(QueryLocalStorageRequest criteria) {
-        return localStorageMapper.queryLocalStoragePage(criteria, PageUtil.getCount(localStorageMapper)).getRecords();
+        return localStorageMapper.queryLocalStoragePageByArgs(criteria, PageUtil.getCount(localStorageMapper)).getRecords();
    }

    @Override
@@ -47,12 +47,12 @@ public class QiniuContentServiceImpl extends ServiceImpl<QiniuContentMapper, Qin

    @Override
    public PageResult<QiniuContent> queryQiniuContentPage(QueryQiniuRequest criteria, Page<Object> page) {
-        return PageUtil.toPage(qiniuContentMapper.queryQiniuContentPage(criteria, page));
+        return PageUtil.toPage(qiniuContentMapper.queryQiniuContentPageByArgs(criteria, page));
    }

    @Override
    public List<QiniuContent> selectQiniuContentByCriteria(QueryQiniuRequest criteria) {
-        return qiniuContentMapper.queryQiniuContentPage(criteria, PageUtil.getCount(qiniuContentMapper)).getRecords();
+        return qiniuContentMapper.queryQiniuContentPageByArgs(criteria, PageUtil.getCount(qiniuContentMapper)).getRecords();
    }

    @Override
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
 <mapper namespace="cn.odboy.application.tools.mapper.LocalStorageMapper">
-    <select id="queryLocalStoragePage" resultType="cn.odboy.model.tools.domain.LocalStorage">
+    <select id="queryLocalStoragePageByArgs" resultType="cn.odboy.model.tools.domain.LocalStorage">
        select
        *
        from tool_local_storage
@@ -7,7 +7,7 @@
        WHERE name = #{name}
    </select>

-    <select id="queryQiniuContentPage" resultType="cn.odboy.model.tools.domain.QiniuContent">
+    <select id="queryQiniuContentPageByArgs" resultType="cn.odboy.model.tools.domain.QiniuContent">
        SELECT
        *
        FROM tool_qiniu_content
@@ -1,68 +0,0 @@
-## Mapper（持久层）
-
- 分页&列表(2合1)：query{TableSimpleName}By{ParamName}
-    - queryUserByCriteria
-    - queryHostByCriteria
- 分页查询：query{TableSimpleName}PageBy{ParamName}
-    - queryUserPageByCriteria
-    - queryUserPageByUserId
- 查询列表：select{TableSimpleName}ListBy{ParamName}
-    - selectUserListByCriteria
-    - selectUserListByUserId
- 查询一个：get{TableSimpleName}By{ParamName}
-    - getUserByUserId
-    - getUserByCriteria
- 批量更新：update{ParamName}ByIds
-    - updateHostNameByIds
-    - updateHostIPByIds
- 批量删除：delete{TableSimpleName}ByIds
-    - deleteHostByIds
-    - deleteUserByIds
- 统计数量：get{具体语义}Count
-    - getUserOnlineCount
-    - getAlarmTotalCount
-
-## Service（业务层）
-
- 分页查询：describe{TableSimpleName}Page
-    - describeUserPage
-    - describeHostPage
- 查询列表：describe{TableSimpleName}List
-    - describeUserList
-    - describeHostList
- 查询元数据：describe{TableSimpleName}{AttributeName}MetadataOptions
-    - describeHostIpMetadataOptions
-    - describeUserSexMetadataOptions
- 批量更新：modify{TableSimpleName}Attribute
-    - modifyHostAttribute
-    - modifyUserAttribute
-    - modifyHostIp
-    - modifyUserSex
- 批量删除：delete{TableSimpleName}ByIds
-    - deleteHostByIds
-    - deleteUserByIds
- 执行业务：{action}{TableSimpleName}{s}
-    - createInstance 创建实例
-    - createInstances 批量创建实例
-    - startInstance 启动实例
-    - stopInstance 停止实例
-    - rebootInstance 重启实例
-    - renewInstance 续费实例
-    - reActiveInstance 激活实例
- 其他业务动词参考
-    - create 创建
-    - delete 删除
-    - modify 修改
-    - scale 扩容
-    - attach 追加
-    - remove 移除
-    - upgrade 升级
-    - sync 同步
-    - install 安装
-    - unInstall 卸载
-    - grant 授权
-    - pause 暂停
-    - cancel 取消
-    - resume 重新开始
-    - check 检查
-    - deploy 部署