0622 公司项目 CodeReview 问题及总结

本贴最后更新于 2913 天前,其中的信息可能已经时移世异
 
后台代码部分
1. 枚举类的使用:当定义的某个字段有多种状态值或表示值时,可以创建一个枚举类将所有状态表示出来,并供其他使用到该字段的方法统一调用。枚举类定义可参考 '/banking-dbbp-product-comp/src/main/java/com/vivebest/banking/dbbp/product/comp/Enums/ProductTypeEnum.java'。
2. 异常处理,在调用其它项目接口时一定要进行异常处理,在抛出异常时需要使用logger.info()对异常进行打印,异常处理格式如下,
 
3. 日志打印不用转换成json对象再输出,如果是打印实体类对象在编写时直接构建toString()方法即可,方式是 右键实体类--> Source --> Generate toString()。
4. 后台日志打印主要有info和debugger两种形式,在进入后台Action时使用logger.info()打印信息,在抛出异常前使用logger.info()打印信息,调用其它方法是使用logger.debugger()来打印信息。info主要是用来判断参数信息是否正确,debugger主要用来查看程序走到了哪一步。
5. 打印日志时要使用占位符‘{}’,不建议使用字符串拼接‘+’的形式,使用‘+’是字符串拼接,会浪费系统资源,后期调整为error级别时,仍会进行字符串的运算,在进行压力测试的时候或者是高并发的情况下,影响系统的性能。使用‘,’符进行占位,效率比较高,方便日后日志筛选与查看。
6. 自定义异常处理时,异常的定义要规范化,同时要包含一定的业务含义,使代码具有可读性。
7. 有返回值的实体类或者List和Map都不能使用New()操作,直接在定义时直接初始化=null即可,如: List resultList = null或者直接 List<PublishAuditor> resultList = publishAuditorService.query(publishAuditor);使用New()操作会消耗额外资源。
8. 删除操作、插入操作和更新操作都不需要有返回值接收,查询操作时选择适当的容器来进行接收查询数据。
9. 日期类型的转换有公共的Utils类中有方法可以直接调用,可以避免手写转换,在第三方jar包 org.apache.http.client.util.DateUtils中可直接时候,使用方法为 Date date = DateUtils.parseDate()。
10. 在Action执行完数据库操作后向前台返回数据时,不需要手动自定义标识符,系统框架会自动返回前台可识别的标识符。不需要特意putResponse出执行成功或失败的标识,平台级的报文中会有resultType为N的,同时前端会对错误进行处理的。
11. 当从前台接收到的某个字段需要经常做转换或者处理时,可以在定义接收该字段的实体类中的Set()方法中进行处理,避免了在其他层频繁处理。
12. Action层主要负责业务和模块的组装,用来写业务的流程。Service层用来进行具体的业务操作和数据处理。当Action接收到参数时,在Action进行数据的组装。Action层处理大的业务逻辑,即主要业务逻辑流程的串接,Service层做具体的小业务的流程,以及数据的处理等
13. 在使用MyBatis在XML里面编写SQL语句时,需要联表查询并编写多个Join语句时,应该把每个Join语句单独成行,方便一眼看出关联了哪些表。如下:
 
14. 对于数据的组装和赋值,应多使用工具类,如dozzer 或者beanUtils中的些对象之间的赋值,尽量减少set方法。使代码具有简洁、可读性。
 
前端代码
1. 前端的组件如tab id或者name进行命名的时候要有明确含义,尽量避免tab-1、tab-2这种无意义的命名。
2. 编写JS文件时要在对应页面下创建JS文件夹,并且JS文件也要有适当的注释,关键字段和方法也应加上注释。
3. 在一个页面有多个Tab展示不同的加载数据时,可以给tab添加定时器,在点击一个tab后对后面的tab进行预加载,不必一次性加载全部数据,也不必只有点击之后才加载数据。
4. 当前端页面多次用到同一个组件的某个属性时,可以添加一个class id,并在CSS或通过Jquery来进行统一控制。
 
 
 
  • 笔记

    好记性不如烂笔头。

    310 引用 • 794 回帖 • 1 关注
  • 字段
    3 引用 • 22 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • feix

    mark 一下总没错

  • seanlee
    作者

    为什么我的博客会自动同步到黑客派上面来。。。

    1 回复
  • ZephyrJung

    估计你在黑客派的 b3 上配置了 key
    也可能是同账号登录自动关联了
    总之你在设置里改一下就好了

    1 回复
  • yangyujiao via macOS

    很好很好。
    后台部分,基本上都符合我们现在写的东西.
    14,我更喜欢用 set,以前的时候喜欢用 beancopy,后来发现坑太多,就换回了 set 了···
    7,用 idea 的好处就是,如果你 new 了,会提示你那是没有用的。然后删掉就好。
    6,异常处理我们也用枚举类型,
    c617347888f142ab933c8df124aa38dd-image.png

    886294bfa18b4190a8fcaa436b19ec97-image.png

    1 回复
  • lee528066

    第 3 点:有些 bean 还是需要用到 jsonString 比如 SDK 中 dto 实体类,还有第三方 jar 中的实体类等。

    1 回复
  • seanlee
    作者

    我在博客后台没有找到相关设置项,可能是使用相同账户的原因

    2 回复
  • someone1764

    其实这个分享一下也挺好的

    1 回复
  • seanlee
    作者

    嗯,受教了,可是我们项目组还是在用 Eclipse,这是我上周自己总结的,里面还有些问题我也不是很懂 😢

  • seanlee
    作者

    嗯,我总结的知识自己和同事在各自业务上代码编写存在的问题,所以原本只是记录在自己博客里面回头查看的,不小心同步到论坛上了 😂

  • seanlee
    作者

    下次 CodeReview 我会好好总结一下再发,这次发的都是自己上周总结的,没有太认真的整理,不小心就同步到论坛上了。。。

  • ZephyrJung

    博客后台好像确实没有这个设置
    你可以在黑客派的设置里的 B3 选项中,将 B3log Key 删掉来阻止同步
    不过还是希望大牛们多多分享博客到论坛上来呀,这就是 solo&sym 的初衷

请输入回帖内容 ...

推荐标签 标签

  • Sym

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台。

    下一代的社区系统,为未来而构建

    524 引用 • 4601 回帖 • 710 关注
  • Sandbox

    如果帖子标签含有 Sandbox ,则该帖子会被视为“测试帖”,主要用于测试社区功能,排查 bug 等,该标签下内容不定期进行清理。

    437 引用 • 1238 回帖 • 586 关注
  • AWS
    11 引用 • 28 回帖 • 9 关注
  • etcd

    etcd 是一个分布式、高可用的 key-value 数据存储,专门用于在分布式系统中保存关键数据。

    6 引用 • 26 回帖 • 540 关注
  • PWA

    PWA(Progressive Web App)是 Google 在 2015 年提出、2016 年 6 月开始推广的项目。它结合了一系列现代 Web 技术,在网页应用中实现和原生应用相近的用户体验。

    14 引用 • 69 回帖 • 184 关注
  • 浅吟主题

    Jeffrey Chen 制作的思源笔记主题,项目仓库:https://github.com/TCOTC/Whisper

    1 引用 • 28 回帖 • 2 关注
  • 周末

    星期六到星期天晚,实行五天工作制后,指每周的最后两天。再过几年可能就是三天了。

    14 引用 • 297 回帖 • 2 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    412 引用 • 3588 回帖
  • 七牛云

    七牛云是国内领先的企业级公有云服务商,致力于打造以数据为核心的场景化 PaaS 服务。围绕富媒体场景,七牛先后推出了对象存储,融合 CDN 加速,数据通用处理,内容反垃圾服务,以及直播云服务等。

    29 引用 • 230 回帖 • 124 关注
  • SVN

    SVN 是 Subversion 的简称,是一个开放源代码的版本控制系统,相较于 RCS、CVS,它采用了分支管理系统,它的设计目标就是取代 CVS。

    29 引用 • 98 回帖 • 694 关注
  • PHP

    PHP(Hypertext Preprocessor)是一种开源脚本语言。语法吸收了 C 语言、 Java 和 Perl 的特点,主要适用于 Web 开发领域,据说是世界上最好的编程语言。

    167 引用 • 408 回帖 • 489 关注
  • jsDelivr

    jsDelivr 是一个开源的 CDN 服务,可为 npm 包、GitHub 仓库提供免费、快速并且可靠的全球 CDN 加速服务。

    5 引用 • 31 回帖 • 105 关注
  • SQLServer

    SQL Server 是由 [微软] 开发和推广的关系数据库管理系统(DBMS),它最初是由 微软、Sybase 和 Ashton-Tate 三家公司共同开发的,并于 1988 年推出了第一个 OS/2 版本。

    21 引用 • 31 回帖 • 1 关注
  • Latke

    Latke 是一款以 JSON 为主的 Java Web 框架。

    71 引用 • 535 回帖 • 829 关注
  • wolai

    我来 wolai:不仅仅是未来的云端笔记!

    2 引用 • 14 回帖
  • 叶归
    12 引用 • 56 回帖 • 21 关注
  • Hprose

    Hprose 是一款先进的轻量级、跨语言、跨平台、无侵入式、高性能动态远程对象调用引擎库。它不仅简单易用,而且功能强大。你无需专门学习,只需看上几眼,就能用它轻松构建分布式应用系统。

    9 引用 • 17 回帖 • 641 关注
  • 导航

    各种网址链接、内容导航。

    45 引用 • 177 回帖
  • Access
    1 引用 • 3 回帖 • 3 关注
  • SMTP

    SMTP(Simple Mail Transfer Protocol)即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件的规则,由它来控制信件的中转方式。SMTP 协议属于 TCP/IP 协议簇,它帮助每台计算机在发送或中转信件时找到下一个目的地。

    4 引用 • 18 回帖 • 629 关注
  • 30Seconds

    📙 前端知识精选集,包含 HTML、CSS、JavaScript、React、Node、安全等方面,每天仅需 30 秒。

    • 精选常见面试题,帮助您准备下一次面试
    • 精选常见交互,帮助您拥有简洁酷炫的站点
    • 精选有用的 React 片段,帮助你获取最佳实践
    • 精选常见代码集,帮助您提高打码效率
    • 整理前端界的最新资讯,邀您一同探索新世界
    488 引用 • 384 回帖 • 4 关注
  • JetBrains

    JetBrains 是一家捷克的软件开发公司,该公司位于捷克的布拉格,并在俄国的圣彼得堡及美国麻州波士顿都设有办公室,该公司最为人所熟知的产品是 Java 编程语言开发撰写时所用的集成开发环境:IntelliJ IDEA

    18 引用 • 54 回帖
  • 国际化

    i18n(其来源是英文单词 internationalization 的首末字符 i 和 n,18 为中间的字符数)是“国际化”的简称。对程序来说,国际化是指在不修改代码的情况下,能根据不同语言及地区显示相应的界面。

    8 引用 • 26 回帖 • 6 关注
  • Vue.js

    Vue.js(读音 /vju ː/,类似于 view)是一个构建数据驱动的 Web 界面库。Vue.js 的目标是通过尽可能简单的 API 实现响应的数据绑定和组合的视图组件。

    268 引用 • 666 回帖 • 1 关注
  • Git

    Git 是 Linux Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。

    211 引用 • 358 回帖
  • React

    React 是 Facebook 开源的一个用于构建 UI 的 JavaScript 库。

    192 引用 • 291 回帖 • 370 关注
  • 强迫症

    强迫症(OCD)属于焦虑障碍的一种类型,是一组以强迫思维和强迫行为为主要临床表现的神经精神疾病,其特点为有意识的强迫和反强迫并存,一些毫无意义、甚至违背自己意愿的想法或冲动反反复复侵入患者的日常生活。

    15 引用 • 161 回帖 • 2 关注