复杂而艰辛的重构之路--起步

你有没有试过,当你踏入一个新的公司,看到了几千几万几十万代码的时候,那种崩溃的感觉?

代码多不可怕,怕的是代码的可读性、维护性、扩展性是如此之差,这时候该怎么办呢?

当我进入了新的公司,利用了一个星期去熟悉代码,也知道了各个开发的编程习惯,在一个大公司里,没有一个规范的编程宝典,出来的就是这种大杂烩,但作为另一个开发的我,该怎么做呢?顺着他们的开发思路继续写这种代码?

No,It’s Not My Style!

该如何进行慢慢重构,等到一定阶段去跟领导说呢?

1、把现在的hard code统统整理一下,这种小改动,相信任何一个LEADER都不会反对的吧。

针对不同的hardcode要有不同的解决方案,如果hard code仅对本类的话,请在本类中使用private const,如果跨越多个类的,请不要怕麻烦,添加一个类,把这些都设置进去,当然,尽量把这些硬编码的使用归类。

public class Example
{
    public void ExampleMethod()
    {
        //var name = "jamesying"; old class

        //private string
        var name = MyName;

        //public string
        var pname = PublicString.MyName;
    }

    //if jamesying only in this class you can
    private const string MyName = "jamesying";
}

//if jamesying is a public string
public class PublicString
{
    public const string MyName = "jamesying";
}

2、超过50行的方法,进行小重构。超过50行就另外建个方法,相信这个也不会反对吧。

public class Example
{
    public void ExampleMethod()
    {
        if (....)
        {
            //old more than 50 lines
            //do....
            DoMethod();
        }
    }

    public void DoMethod()
    {
        do.....
    }
}

3、尽量不改变原来方法的结构,参数、命名尽量不改动,除非很有争议性。

原有的一些方法分布的不是很合理,比如View层做了逻辑操作,Controller做了数据操作等,遇到这种就重新建一个项目或者建一个类,按照更合理的方式来进行,保持原有方法不改动,只是通过它再去call一下自己的方法。如果遇到一些重复操作,这样有便于以后的维护。

public class ViewExample
{
    public void ExampleMethod(string id, string name, string age)
    {
        //old Do Anything and than for more lines
        //new
        var business = new BusinessClass();
        business.DoExampleMethod(id, name, age);
    }

}

public class BusinessClass
{
    public void DoExampleMethod(string id, string name, string age)
    {
        //old Do anything
    }
}

第三步你是不是觉得多余呢?如果这么觉得,那是你还没有经历过恐怖的项目而已,而且你这种提炼,为以后的维护、改版、更新都会有帮助,这里要注意一点,千万别直接去掉原先的方法参数,因为你不知道有多少地方调用了它,等你的提炼稳定了,试着去改变原先的方法或者去除。

以上只是代码的小改动,相信不难,如果要重新构建一个完全新的系统,这事情还是要多多考虑的,肯定不能一蹴而就的,等完成了上面三步,相信你的领导已经对你刮目相看了,接下来的事情就好办了。

4、统一wcf、webservices、webapi等接口,尽量使用统一方式,方便调用。

如果调用的时候用的是自动更新方式,那就统统使用这种方式,如果是手动编写的,千万别放在一个类里(博主已经崩溃中)

刚接触项目的时候,我一直觉得他们是直接引用,然后手动右键获取更新,谁知道他们是把增量代码手动复制到Reference.cs中,着实让我吃惊不少,what a fuck day!

遇到这个问题,我真心没法修改,动一动把命送,因为merge的都是外国人,英语也不好,只能先暂时跟着他们的思路走,等英语好了再说吧。

5、把项目中的缓存用统一的方式。

编写一个ICache接口,项目中所有使用到缓存的地方都修改掉,为了避免有多个缓存方式,可以写一个CacheFactory或者CacheStrategy,这样方便你在内存方式还是其他方式缓存进行切换。

这个是一个非常有必要的做法,不管你是重构、新建,都一定要注意这点,否则后期你维护或者更换的话会让你痛不欲生。

public interface ICacheExample
{
    void Add(string cacheKey, object obj, TimeSpan expiredTime);

    void Save(string cacheKey, object obj, TimeSpan expiredTime);

    T Get<T>(string cacheKey);

    T Retrieval<T>(string cacheKey, Func<T> func, TimeSpan expiredTime);

    bool Delete(string cacheKey);

    Dictionary<string, object> CacheManagerDict { get; }
}

Add,Save,Delete对应原先的Cache方法,这个大家应该都知道,Retrieval是一个检索方法,如果缓存中没有这个cache,那将执行func委托,得到的结果缓存起来并返回。CacheManagerDict是对缓存的一个管理,有些时候我们需要手动清除某一个缓存,如果你用的HttpCache,那可以不使用这个属性,但如果你是其他方式缓存,或者是分布式的话,建议加一个管理dict,方便你进行管理。

重构之路任重道远,暂时只能进行小改动,大的改动真心不太敢弄,牵涉的东西太多了,但我们如果尽力能做到以上几点,相信对以后的维护、扩展还是有帮助的。

时间: 2024-08-02 06:39:09

复杂而艰辛的重构之路--起步的相关文章

Hybrid框架UI重构之路:三、工欲善其事,必先利其器

上文回顾:Hybird框架UI重构之路:二.事出有因 工欲善其事,必先利其器,事是重构的目标,器是开发环境. 这篇文章将讲述重构时的UI框架的目录结构,且需要使用的开发工具. 目录结构 demo : 开发框架的模板(单页模式) demo-muti : 开发框架的模板(多页模式) demo-scene : 示例模板.一个完整的示例,目的是给使用者稍作修改就可以使用在项目上. demo-template : 给使用者使用的开发模板. demo-whole : 可在PC上演示的示例模板 dist :

Hybrid框架UI重构之路:六、前端那点事儿(Javascript)

上文回顾 :Hybird框架UI重构之路:五.前端那点事儿(HTML.CSS) 这里讲述在开发的过程中,一些JS的关键点. 换肤 对于终端的换肤,我之前一篇文章有说了我的想法. 请查看:http://www.cnblogs.com/lovesong/p/4122262.html   iscroll的问题 1.使用iscroll的页面里面有表单元素,当键盘弹出再缩回后,页面拖不到最顶地方. 这个在android上总出现,使用的iscroll版本是4.2.5. 这原来是个很棘手的问题,导致了有inp

Hybrid框架UI重构之路:四、分而治之

上文回顾:Hybird框架UI重构之路:三.工欲善其事,必先利其器 上一篇文章有说到less.grunt这两个工具,是为了css.js分模块使用的.UI框架提供给使用者的时候,是一个大的xxx.js.xxx.css,但在开发时候,必须划分模块. CSS模块划分 1.variables.less 这里面是一些样式的变量.函数 例: 字体: @baseFontSize: 20px; 圆角: .rounded-corners (@radius: 5px) { border-radius: @radiu

Hybrid框架UI重构之路:五、前端那点事儿(HTML、CSS)

上文回顾 :Hybird框架UI重构之路:四.分而治之 这里讲述在开发的过程中,一些HTML.CSS的关键点. 单页模式的页面结构 在单页模式中,弱化HTML的概念,把HTML当成一个容器,BODY中显示的主体内容才是页面,一个HTML容器中可以存放1个或者多个页面,每个页面放置于section中.而一个页面(section)中必有主体内容(content),也有可能包含头部内容.底部内容,甚至一些侧滑菜单等. 所以,以我们通常看到的一个移动应用的界面中包含了顶部Title和主体内容的页面代码如

Hybrid框架UI重构之路:二、事出有因

上文回顾:Hybird框架UI重构之路:一.师其长技以自强   一切的重构都是有原因的,或许为了更快速度.更好体验.更快捷开发等,于是就有了自己的开发目标,简单看看未重构前UI("中国移动式"风格). 上一篇文章说明调查了这么多类似框架,对比了他们的特点,而比对自身UI,也是存在可优化的地方,于是有了下面几点目标(仅仅UI框架方面,不涉及原生部分). (1)规范开发 1.SVN版本控制.之前的UI框架部分是没有进行svn版本控制的,于是会导致个问题--有些文件在多次修改后,连当初的开发

赵慧玲:网络重构之路漫长,SDNFV挑战诸多

4月18日,2017全球未来网络发展峰会SDN/NFV技术与应用论坛于南京江宁隆重召开.会上,中国通信学会常务理事赵慧玲发表了"SDNFV实践与挑战"的主题演讲.赵慧玲表示,网络重构的主要挑战涉及网络层面和运营层面,其中网络层面主要涉及SDN和NFV,而运营层面主要包括网络编排和业务编排两大方面. 据悉,Gartner技术成熟度曲线表明,SDN/NFV已经趋近成熟.数据显示2015到2016年间,运营商采用x86的服务器中47%用于SDN/NFV(OSS/BSS占29%,云关联服务占1

Android Studio重构之路,我们重新来了解一下Google官方的Android开发工具

Android Studio重构之路,我们重新来了解一下Google官方的Android开发工具 记得我的第一篇博客就是写Android Studio,但是现在看来还是有些粗糙了,所有重构了一下思路,覆写了一篇 Google主推-Android开发利器--Android Studio,这可能是最全的AS教程! Android Studio,自Google2013年发布以来,就倍受Android开发者的喜爱,我们本书,就是基于Android Studio来进行案例演示的,大家都知道,Android

Android Camera探究之路——起步

Android Camera探究之路--起步 Camera在手机中有着举足轻重的地位,不管是二维码还是照片.识别,都离不开摄像头,本文将对Android中的Camera进行全面解析. 权限镇楼: <uses-permission android:name="android.permission.CAMERA"/> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE&

代码重构之路的艰辛

此文属转载,原文链接:http://www.cnblogs.com/viter/archive/2010/11/03/1868377.html 正文如下:   我承认,这个标题很沉重.我有幸使用了一个开源的项目作为小范围内的二次开发应用.这个项目其实是挺大的,开源代码仅是其中一部分,在二次开发中我对源代码作了一些改进,都是一些必要的改进以及发现的BUG:这些BUG在后续的开源参与者一一修复.我想说的是重构过程中的一些小问题. 一.如果你决定重构代码,特别是别人的代码,最好对整个项目有一个清晰的认