0622 公司项目 CodeReview 问题及总结

本贴最后更新于 2824 天前,其中的信息可能已经时移世异
 
后台代码部分
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来进行统一控制。
 
 
 
  • 笔记

    好记性不如烂笔头。

    311 引用 • 796 回帖
  • 字段
    3 引用 • 22 回帖

相关帖子

欢迎来到这里!

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

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

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

    1 回复
  • 其他回帖
  • yangyujiao via macOS

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

    886294bfa18b4190a8fcaa436b19ec97-image.png

    1 回复
  • ZephyrJung

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

  • seanlee
    作者

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

    2 回复
  • 查看全部回帖

推荐标签 标签

  • 安装

    你若安好,便是晴天。

    132 引用 • 1184 回帖
  • Ant-Design

    Ant Design 是服务于企业级产品的设计体系,基于确定和自然的设计价值观上的模块化解决方案,让设计者和开发者专注于更好的用户体验。

    17 引用 • 23 回帖 • 1 关注
  • 开源中国

    开源中国是目前中国最大的开源技术社区。传播开源的理念,推广开源项目,为 IT 开发者提供了一个发现、使用、并交流开源技术的平台。目前开源中国社区已收录超过两万款开源软件。

    7 引用 • 86 回帖
  • Dubbo

    Dubbo 是一个分布式服务框架,致力于提供高性能和透明化的 RPC 远程服务调用方案,是 [阿里巴巴] SOA 服务化治理方案的核心框架,每天为 2,000+ 个服务提供 3,000,000,000+ 次访问量支持,并被广泛应用于阿里巴巴集团的各成员站点。

    60 引用 • 82 回帖 • 610 关注
  • 学习

    “梦想从学习开始,事业从实践起步” —— 习近平

    172 引用 • 514 回帖
  • 小说

    小说是以刻画人物形象为中心,通过完整的故事情节和环境描写来反映社会生活的文学体裁。

    31 引用 • 108 回帖 • 1 关注
  • 宕机

    宕机,多指一些网站、游戏、网络应用等服务器一种区别于正常运行的状态,也叫“Down 机”、“当机”或“死机”。宕机状态不仅仅是指服务器“挂掉了”、“死机了”状态,也包括服务器假死、停用、关闭等一些原因而导致出现的不能够正常运行的状态。

    13 引用 • 82 回帖 • 78 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份,是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析,让电信用户访问电信的服务器,网通的用户访问网通的服务器,教育网的用户访问教育网的服务器,达到互联互通的效果。

    6 引用 • 26 回帖 • 524 关注
  • Gzip

    gzip (GNU zip)是 GNU 自由软件的文件压缩程序。我们在 Linux 中经常会用到后缀为 .gz 的文件,它们就是 Gzip 格式的。现今已经成为互联网上使用非常普遍的一种数据压缩格式,或者说一种文件格式。

    9 引用 • 12 回帖 • 170 关注
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    116 引用 • 54 回帖 • 3 关注
  • HTML

    HTML5 是 HTML 下一个的主要修订版本,现在仍处于发展阶段。广义论及 HTML5 时,实际指的是包括 HTML、CSS 和 JavaScript 在内的一套技术组合。

    108 引用 • 295 回帖 • 1 关注
  • Sillot

    Insights(注意当前设置 master 为默认分支)

    汐洛彖夲肜矩阵(Sillot T☳Converbenk Matrix),致力于服务智慧新彖乄,具有彖乄驱动、极致优雅、开发者友好的特点。其中汐洛绞架(Sillot-Gibbet)基于自思源笔记(siyuan-note),前身是思源笔记汐洛版(更早是思源笔记汐洛分支),是智慧新录乄终端(多端融合,移动端优先)。

    主仓库地址:Hi-Windom/Sillot

    文档地址:sillot.db.sc.cn

    注意事项:

    1. ⚠️ 汐洛仍在早期开发阶段,尚不稳定
    2. ⚠️ 汐洛并非面向普通用户设计,使用前请了解风险
    3. ⚠️ 汐洛绞架基于思源笔记,开发者尽最大努力与思源笔记保持兼容,但无法实现 100% 兼容
    29 引用 • 25 回帖 • 104 关注
  • Shell

    Shell 脚本与 Windows/Dos 下的批处理相似,也就是用各类命令预先放入到一个文件中,方便一次性执行的一个程序文件,主要是方便管理员进行设置或者管理用的。但是它比 Windows 下的批处理更强大,比用其他编程程序编辑的程序效率更高,因为它使用了 Linux/Unix 下的命令。

    124 引用 • 74 回帖
  • 互联网

    互联网(Internet),又称网际网络,或音译因特网、英特网。互联网始于 1969 年美国的阿帕网,是网络与网络之间所串连成的庞大网络,这些网络以一组通用的协议相连,形成逻辑上的单一巨大国际网络。

    99 引用 • 367 回帖
  • 周末

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

    14 引用 • 297 回帖 • 1 关注
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用
  • OpenShift

    红帽提供的 PaaS 云,支持多种编程语言,为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 649 关注
  • 链书

    链书(Chainbook)是 B3log 开源社区提供的区块链纸质书交易平台,通过 B3T 实现共享激励与价值链。可将你的闲置书籍上架到链书,我们共同构建这个全新的交易平台,让闲置书籍继续发挥它的价值。

    链书社

    链书目前已经下线,也许以后还有计划重制上线。

    14 引用 • 257 回帖 • 3 关注
  • 域名

    域名(Domain Name),简称域名、网域,是由一串用点分隔的名字组成的 Internet 上某一台计算机或计算机组的名称,用于在数据传输时标识计算机的电子方位(有时也指地理位置)。

    43 引用 • 208 回帖
  • RemNote
    2 引用 • 16 回帖 • 9 关注
  • SQLite

    SQLite 是一个进程内的库,实现了自给自足的、无服务器的、零配置的、事务性的 SQL 数据库引擎。SQLite 是全世界使用最为广泛的数据库引擎。

    5 引用 • 7 回帖
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    586 引用 • 3538 回帖 • 1 关注
  • 创造

    你创造的作品可能会帮助到很多人,如果是开源项目的话就更赞了!

    182 引用 • 1010 回帖
  • WiFiDog

    WiFiDog 是一套开源的无线热点认证管理工具,主要功能包括:位置相关的内容递送;用户认证和授权;集中式网络监控。

    1 引用 • 7 回帖 • 604 关注
  • Wide

    Wide 是一款基于 Web 的 Go 语言 IDE。通过浏览器就可以进行 Go 开发,并有代码自动完成、查看表达式、编译反馈、Lint、实时结果输出等功能。

    欢迎访问我们运维的实例: https://wide.b3log.org

    30 引用 • 218 回帖 • 640 关注
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    76 引用 • 1742 回帖
  • Flutter

    Flutter 是谷歌的移动 UI 框架,可以快速在 iOS 和 Android 上构建高质量的原生用户界面。 Flutter 可以与现有的代码一起工作,它正在被越来越多的开发者和组织使用,并且 Flutter 是完全免费、开源的。

    39 引用 • 92 回帖