java的 大模型提示词 prompt 代码规范 ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■提示词■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■开始### 一、核心编码原则1.遵循SOLID设计原则代码具备高内聚、低耦合特性避免冗长的巨型类/方法单个方法代码量不超过80行。2.基于Spring Boot/Spring Cloud生态开发严格区分控制层Controller、服务层Service、数据访问层Mapper/Repository、配置层Config、VO/DTO/PO层禁止跨层调用。3.全程采用面向接口编程服务层先定义接口XXXService再实现类XXXServiceImpl通过Service/Resource注入。### 二、分层编码规范#### 1. 配置层独立配置类-所有配置项如数据源、线程池、MQ、Redis、第三方SDK等必须独立封装为XXXConfig类通过Configuration注解标识。-配置参数优先从application.yml/application.properties读取使用Value或ConfigurationProperties绑定禁止硬编码常量。-示例/** * 文档权限模块 - Redis配置类 * author VAMA */ConfigurationConfigurationProperties(prefixdoc.permission.redis)Slf4jpublicclassDocumentPermissionRedisConfig{/** Redis缓存过期时间秒 */privateIntegerexpireSeconds300;/** Redis缓存前缀 */privateStringprefixdoc:permission:;/** * 构建文档权限缓存Key * param resourceId 资源ID * param tenantId 租户ID * return 拼接后的缓存Key */publicStringbuildCollaboratorCacheKey(LongresourceId,LongtenantId){returnStrUtil.format({}{}:{},prefix,resourceId,tenantId);}// getter/setter}#### 2. 服务层Service规范-方法头必须包含完整的JavaDoc注释-格式/** 【操作类型】功能描述 */param 每个参数的简洁注释return返回值说明throws 异常说明如有。-操作类型统一【查询】【新增】【修改】【删除】【批量新增】【批量修改】【批量删除】【校验】【更新】等。-方法内部逻辑分块注释变量定义、参数校验、核心业务、返回结果关键步骤添加日志INFO级别异常场景添加ERROR级别日志。-禁止在服务层捕获全局异常统一交给全局异常处理器但需对业务异常主动抛出如AssertUtils断言。-事务控制涉及多表操作的方法添加Transactional注解明确rollbackFor属性如Transactional(rollbackForException.class)。-示例参考批量删除资源协作者权限的Service方法已提供。/** * 资源可见协作者 Service 接口 * author VAMA */publicinterfaceDocumentCollaboratorService{/** * 【更新】-批量更新资源文件/文件夹协作者权限单个/批量 * param reqVO 更新请求 VO * return 协作者列表 */BooleanbatchUpdateResourceCollaboratorPermission(DocumentCollaboratorListBatchUpdateReqVOreqVO);/** * 【删除】-批量删除资源文件/文件夹协作者权限单个/批量 * param reqVO 删除请求 VO * return 协作者列表 */BooleanbatchDeleteResourceCollaborator(DocumentCollaboratorListBatchDeleteReqVOreqVO);}/** * 【删除】批量删除资源协作者权限 * param reqVO 更新请求 VO * return 协作者列表 */OverridepublicBooleanbatchDeleteResourceCollaborator(DocumentCollaboratorListBatchDeleteReqVOreqVO){/* *********************************变量****************************************/LongloginUserIdgetLoginUserId();LongtenantIdTenantContextHolder.getTenantId();ListLonguserIdListreqVO.getUserIdList();IntegerresourceTypereqVO.getResourceType();LongresourceIdreqVO.getResourceId();log.info([batchDeleteResourceCollaborator][【删除】批量删除资源协作者权限] loginUserId{}, tenantId{}, userIdList{}, resourceType{}, resourceId{},loginUserId,tenantId,userIdList.toString(),resourceType,resourceId);/* *********************************校验****************************************///校验-当前用户是否有管理员权限BooleanhasManagePermissiondocumentPermissionService.checkUserHasResourceManagePermission(loginUserId,resourceType,resourceId,tenantId);AssertUtils.isFalse(hasManagePermission,ErrorCodeConstants.DOCUMENT_ADMIN_ACCESS_DENIED);//文档管理权限不足//校验-判断列表中是否有管理员管理员不可以改管理员权限BooleanisExistManagedocumentPermissionMapper.checkUserIdListIsExistManage(tenantId,userIdList,resourceType,resourceId);AssertUtils.isTrue(isExistManage,ErrorCodeConstants.DOCUMENT_PERMISSION_CANNOT_MODIFY_MANAGE);//您无法修改同级管理员的权限。如需调整请联系创建者。/* *********************************业务****************************************///删除-批量删除权限协作者-用户类型intdeleteUserCount0;intdeleteDeptCount0;//删除-批量删除权限协作者-用户类型if(CollectionUtils.isNotEmpty(reqVO.getUserIdList())){// 发送权限移除消息和权限审计日志this.sendMQPermissionRemoveAndAuditLog(resourceType,resourceId,userIdList);//删除权限deleteUserCountdocumentPermissionMapper.deleteByResourceTypeAndResourceIdAndTargetTypeAndTargetIdList(resourceType,resourceId,DocumentPermissionTargetTypeEnum.USER.getType(),reqVO.getUserIdList(),tenantId);}//删除-批量删除权限协作者-部门类型if(CollectionUtils.isNotEmpty(reqVO.getDeptIdList())){deleteDeptCountdocumentPermissionMapper.deleteByResourceTypeAndResourceIdAndTargetTypeAndTargetIdList(resourceType,resourceId,DocumentPermissionTargetTypeEnum.DEPT.getType(),reqVO.getDeptIdList(),tenantId);}log.info([batchDeleteResourceCollaborator][【删除】批量删除资源协作者权限] deleteUserCount{},deleteDeptCount{},deleteUserCount,deleteDeptCount);returntrue;}#### 3. 控制层Controller规范-控制层仅负责接收请求、参数校验、调用服务层、返回响应**禁止编写任何业务逻辑**。-类注释/** 模块类型 - 业务模块 Controller */author 信息。-注解规范-类级别RestControllerRequestMapping根路径TagOpenAPI标签ValidatedSlf4j。-方法级别Operationsummary标注【操作类型】功能描述HTTP方法注解GetMapping/PostMapping等。-参数校验入参通过Valid/Validated注解触发JSR380校验如NotNull/NotBlank/Min等参数类ReqVO字段添加校验注解和注释。-响应统一所有接口返回CommonResultT类型通过success()/error()方法封装响应码、响应信息、数据体禁止直接返回原始对象。-示例参考文档权限Controller已提供。/** * 用户端 - 文档权限 Controller * author VAMA */Tag(name用户端 - 文档权限 - 协作者)RestControllerRequestMapping(/doc/permission)Validated Slf4jpublicclassDocumentPermissionController{ResourceprivateDocumentPermissionServicedocumentPermissionService;ResourceprivateDocumentSharingScopeServiceresourceSharingScopeService;ResourceprivateDocumentNotificationProducerdocumentNotificationProducer;ResourceprivateSystemDeptApisystemDeptApi;ResourceprivateDocumentCollaboratorServicedocumentCollaboratorService;//-----------------------共享范围----------------------------PostMapping(/query-resource-sharing-scope)Operation(summary【查询】更新资源共享范围(文件/文件夹))publicCommonResultDocumentSharingScopeQueryRespVOqueryResourceSharingScope(Valid RequestBodyDocumentSharingScopeQueryReqVOreqVO){returnsuccess(resourceSharingScopeService.queryResourceSharingScope(reqVO));}#### 4. 数据访问层Mapper/Repository-基于MyBatis-Plus实现Mapper接口继承BaseMapperPO禁止在Mapper中编写业务逻辑。-SQL语句优先通过XML文件编写复杂SQL拆分避免嵌套过深添加字段注释。-分页查询统一使用IPage分页对象禁止手写LIMIT/OFFSET。-示例/** * 文档权限 Mapper * author VAMA */MapperpublicinterfaceDocumentPermissionMapperextendsBaseMapperDocumentPermissionPO{/** * 校验用户列表是否包含管理员 * param tenantId 租户ID * param userIdList 用户ID列表 * param resourceType 资源类型 * param resourceId 资源ID * return true-包含管理员false-不包含 */BooleancheckUserIdListIsExistManage(Param(tenantId)LongtenantId,Param(userIdList)ListLonguserIdList,Param(resourceType)IntegerresourceType,Param(resourceId)LongresourceId);}#### 5. VO/DTO/PO层规范-严格区分三类对象-PO数据库实体类对应表结构添加TableName/TableId/TableField注解字段名与数据库保持一致下划线转驼峰。-VO视图对象前端入参/出参分为ReqVO请求/RespVO响应添加Data/NoArgsConstructor/AllArgsConstructor注解字段添加中文注释。-DTO数据传输对象服务层内部传输用于多表联查/复杂数据组装。-示例/** * 批量删除资源协作者请求 VO * author VAMA */Data NoArgsConstructor AllArgsConstructorpublicclassDocumentCollaboratorListBatchDeleteReqVO{/** 资源ID */NotNull(message资源ID不能为空)privateLongresourceId;/** 资源类型1-文件2-文件夹 */NotNull(message资源类型不能为空)privateIntegerresourceType;/** 用户ID列表 */privateListLonguserIdList;/** 部门ID列表 */privateListLongdeptIdList;}### 三、接口设计规范RESTful风格强化1.接口路径命名-全部使用小写字母多单词用短横线-分隔如/doc/permission/query-resource-sharing-scope。-路径仅包含资源名词不包含动词通过HTTP方法表达操作-GET查询单个/列表如GET/doc/permission/collaborator/{resourceId}查询指定资源的协作者。-POST新增/提交如POST/doc/permission/collaborator新增协作者。-PUT全量更新如PUT/doc/permission/collaborator更新协作者全部信息。-PATCH部分更新如PATCH/doc/permission/collaborator/{userId}修改指定用户的权限。-DELETE删除如DELETE/doc/permission/collaborator/batch批量删除协作者。2.版本控制接口版本通过路径/v1/doc/permission或请求头X-API-Version:v1区分禁止在接口名中加版本号。3.分页参数统一使用pageNum页码默认1、pageSize页大小默认10作为请求参数响应包含total总条数、list数据列表。4.响应码规范-200请求成功。-400参数错误。-401未登录/Token过期。-403权限不足。-404资源不存在。-500服务器内部错误。### 四、通用编码规范1.注释规范-类注释必须包含功能描述、作者可选版本、创建时间。-方法注释必须包含功能描述、参数说明、返回值说明异常场景添加throws。-字段注释PO/VO/DTO的字段必须添加中文注释说明字段含义。-禁用无用注释如// TODO、// 此处省略代码等。2.异常处理-自定义业务异常BusinessException统一通过全局异常处理器RestControllerAdvice捕获。-禁止使用try-catch捕获所有异常仅捕获明确需要处理的异常如IO异常、第三方接口调用异常。-异常信息必须包含上下文如用户ID、资源ID便于排查问题。3.日志规范-统一使用Slf4jSlf4j禁止使用System.out.println。-日志格式[方法名][操作描述]关键字段1{},关键字段2{}。-日志级别DEBUG调试、INFO正常流程、WARN警告、ERROR异常生产环境禁用DEBUG级别。4.命名规范-类名大驼峰PascalCase如DocumentPermissionService。-方法名/变量名小驼峰camelCase如batchDeleteResourceCollaborator。-常量全大写下划线分隔如ERROR_CODE_CONSTANTS.DOCUMENT_ADMIN_ACCESS_DENIED。-包名全小写如com.vama.doc.permission.controller。5.其他-禁止使用魔法值如数字1/2、字符串user统一封装为枚举Enum或常量类。-集合操作必须判空使用CollectionUtils.isEmpty/NotEmpty避免空指针异常。-数据库操作必须考虑租户隔离TenantContextHolder所有SQL添加tenant_id条件。-接口入参必须通过Valid/Validated校验禁止在服务层重复校验特殊场景除外。6.忽略CommonResult 和 全局异常处理器 的编写过程 ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■提示词■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■结束