公司代码规范实践与指南-优快云博客

本文链接：https://blog.youkuaiyun.com/ly_moran/article/details/79395808

本文介绍了公司内部的代码规范，包括请求路径的命名规则、列表页编码格式的规定、异常处理的方法、异常日志记录与反馈、参数非空判断以及返回结果的验证，旨在提升代码质量和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.请求路径要"见名知意" 开头小写驼峰式请求名要与方法名同名

 @RequestMapping("/goHomeBannerList")
    public String goHomeBannerList(HttpServletRequest request, HttpServletResponse response) {};

2.在跳转list(查询列表)页时要规定编码格式

response.setContentType("text/xml;charset=utf-8");

3.方法内部涉及到异常处理的情况要用 try catch 快包围并对异常进行处理

 try {
            return "friend/homeBanner/homeBannerList";
        } catch (Exception e) {
            hdLog.error("|FriendHomeBannerAction|goHomeBannerList|"+new Date().getTime(),e);
            request.setAttribute("message", RetCodeAndMessage.SERVER_ERROR[1]);
            return "500";
        }

4.在跳转异常时, 要添加异常日志信息 .如果是异常页要把异常信息也返回给页面, 如果是ajax 要把异常信息放入json中返回页面

 hdLog.error("|FriendHomeBannerAction|goHomeBannerList|"+new Date().getTime(),e);
            request.setAttribute("message", RetCodeAndMessage.SERVER_ERROR[1]);
            return "500";

5.对于接受参数:要对接受的参数进行"非空判断"

            String imgUrl = request.getParameter("url");
            String title = request.getParameter("title");
            if (StringUtils.isEmpty(imgUrl) || StringUtils.isEmpty(title)) {
                json = RetCodeAndMessage.getRetJson(RetCodeAndMessage.INCOMPLETE_PARAMETER);//INCOMPLETE_PARAMETER 请求参数不全
                renderJson(json.toString(),response);
                return;
            }

6.对于获取表信息返回的参数要进行判断

//impl返回 参数
 return ServiceRetCode.returnCode(RetCodeAndMessage.SUCCESS, articleDB);

Object[] getArticleDBResult = friendArticleService.getArticleDB(new BigInteger(articleId));
                if (!RetCodeAndMessage.SUCCESS[0].equals(getArticleDBResult[0])) {
                    json = RetCodeAndMessage.getRetJson(getArticleDBResult);
                    renderJson(json.toString(),response);
                    return;
                }