最近对一个老的系统进行重构,有些感触,写出来做个总结
重构的原则
保证和第三方的交互接口没有变化,保证新系统上线后,第三方不需要任何改动就可以使用新系统
新系统的功能不能少于老系统正在使用的功能
修正老系统中存在的bug,优化性能
沟通
尽可能的拿到新系统的相关资料
和熟悉业务的开发,测试,项目经理等沟通,熟悉业务
使用老系统,加深对老系统的了解
列出所有需要重构的功能,初步和相关人员达到一致
在本地运行要重构的工程
部署本地的开发环境,包括数据库,依赖的第三方服务
阅读别人的重构
拿到源代码,查看依赖jar和配置文件,了解老系统使用了哪些框架,使用了什么服务
在本地运行老系统代码,一一运行重构功能,通过系统日志,加深对系统的了解
找出系统的核心业务的代码入口,从这一部分开始阅读代码。在读的过程中自动会延伸到其它相关的模块。把这些核心模块阅读完成后,一般基本重构功能就看七七八八。最后把剩余的功能看完
在看的过程,需要做以下事情
如果对业务有疑问,随时和业务熟悉的人员进行交流。如果当时就能确认最好,如果不能,则进行记录。这些疑问等你读完代码后,再回头看,基本都能明白
看代码时,会发现老系统中存在的bug,先记录下来
看代码时,会产生如何改进系统的想法,这些想法也先记录下来
重构的内容
依赖jar升级
尽量升级依赖jar包到相应的最新的稳定包
对外服务使用了webservice,则相关服务的jar包尽量不要升级。如使用axis2等webservice做为对外服务,如果没有安全的问题,尽量不要升级jar包
JDK升级
老系统的JDK一般比较低。在开发前,和运维沟通,能否对现在的JDK进行升级。如果能,那最好
完善系统架构
对现有的服务部署构架进行完善:每个服务(包括做转发的Ngnix,业务服务)至少保证有两台,并且分布到2台服务器上。
尽量保证每个服务是无状态,这样可以保证系统易于水平扩展
重构:保证代码质量
重复的代码合并:通过抽象类,工具类等解决
魔法数字和1,2,3等状态数据转化为常量值或枚举值
加强对异常数据的安全处理,避免抛出空指针、数组越界等问题
修正bug:
a.隐藏bug,
b.修正已知但是之前因为各种原因无法修复的问题
相同的数据配置只需要一份,不要多份
功能扩展:第三方调用我们的接口的重要数据入库,调用第三方接口的结果入库
提高高频率接口的执行速度
a. 短信回执接口从1s降低到10ms(建立表索引)
b. 订购关系接口执行时间从250s降低到xxms(建立表索引)
程序依赖第三方服务的关系处理
外部服务
不可以修改和第三方交互的接口参数,必需和原来保持一致
对外的服务IP和URL保持不变
内部服务
和服务者开发者直接进行沟通,如果搞不定,可以请领导协调
提高安全性
增加的白名单IP,只有指定的IP可以访问服务
代码中增加对请求参数的校验
提高运维工作量,更早发现存在的问题
上报程序状态到运维平台(如程序是否关闭,启动)
上报程序关键信息到运维平台(如业务逻辑处理异常,执行关键方法花费的时间等)
数据库
原来系统数据和别的服务共用表,现在将数据独立出来,并对数据进行清理,删除异常数据
对大表进行清理,将2016年及之前的数据移出当前的表,备份到别的表中
增加适当数据库索引
为了解决一些历史的BUG,可能需要在数据库中增加新字段或新表
制定重构计划
完善重构功能列表:对系统非常熟悉后,对之前的重构的功能列表进行补充
制定开始计划
对项目的中的风险点进行备案,后期开发测试需要重点注意的地方
和相关人员评审重构计划
测试
测试
a. 开发,测试,项目经理等人沟通设计测试用例,覆盖
b. 测试的范围要细,测试一个功能时,要检查以下信息
检查客户端:是否和预期的相同(如收到短信)
检查服务端:数据库的值是否和预期相同
检查第三方数据:第三方返回的值是否和预期相同,需要请第三一起配合测试
测试异常数据(如发送短信)
测试人员非常重要,需要有足够的耐心对所有的场景进行测试;需要有
c. 本地测试
搭建本地测试环境
使用测试工作模拟调用接口测试(如SOAPUI)
在测试工具中建立常用场景进行测试
用代码写一个客户端,对常用交互场景进行自动化测试
本地环境测试,使用真实数据模拟调用接口测试
d. 线网测试
第一步:在线网部署新程序。如果程序需要向第三方推送数据,则需要启动一个新的服务模拟第三方服务,此程序中和模拟第三方程序推送数据。拦截服务的流量,即向生成环境推送,又向新程序推送。运行一段时间后,然后比较两个程序的产生数据的区别以及各种是否正常运行
第二步:在线网部署新程序,此时程序调用真正的第三方。拦截服务的流量,只将我们测试的请求推送到新程序。
第三步:在线网部署新程序。找一个关系好的接入方,和他们沟通,将他们的一部分流量推送到新服务,请他们确认新服务和他们交互的数据是否正常。等多次测试没问题,可以将他们的流量全部推送到新服务。然后找下一个接入方按照以上流程依次处理。
第四步:所有服务迁移到新程序后,旧服务停止
e. 压力测试
在线网测试的后期,等确认基本功能无误后,需要同时进行压力测试
f. 灰度发布
建立灰度发布的机制