悠然乱弹:从一段代码讲开去

序言

今天偶然看到一框架,在框架的里面有一段这样的描述:

xxx并不愿意其他人来直接修改YYY框架的代码,因为XXX致力于将它打造为完美的作品,其他人写的代码,实在没有加入进来的意义。
但是您可以当小白鼠,提意见,提bug,好的idea我还是愿意接受的。

这里解释一下,其中xxx是作者名字,YYY是框架名称,这么OSC上牛人众多,牛到这个程度的还是第一次见到,于是就想去速度学习一下。其实框架好不好,看例子代码就可以看出一二,去找了找,果然找到了示例代码,我摘了两个方法:

/**
   * 发布文章
   *
   * @return
   */
  public Object add(){
    Request r = Context.get(Statics.REQUEST);
    String title = r.get("title");
    String desc = r.get("desc");
    String content = r.get("content");
    String cats = r.get("cats");
    String pic = r.get("pic");
    String keywords = r.get("keywords");
    List<String> l = new ArrayList<String>();
    String[] cs = cats.split(",");
    for(String s:cs){
      s = s.trim();
      if(!s.equals("")){
        l.add(s);
      }
    }
    Validator.check(title,new RuleNotEmpty("标题"));
    HttpSession session = r.find(WebExecute.TAG_SESSION);
    User user = (User)session.getAttribute(Global.SESSION_USER);
    ITrans t = TransFactory.getTrans();
    String id = ID.next()+"";
    IInserter ins = t.getInserter().table("T_ARTICLE");
    ins.set("C_ID",id);
    ins.set("C_TITLE",title);
    ins.set("C_DESC",desc);
    ins.set("C_USER_ID",user.getId());
    ins.set("C_CONTENT",content);
    ins.set("C_TIME",Dater.ymdhms(Dater.now()));
    ins.set("C_DAY",Dater.ymd(Dater.now()));
    ins.set("C_PIC",pic);
    ins.set("C_KEYWORDS",keywords);
    ins.insert();
    if(l.size()>0){
      for(String cat:l){
        t.getInserter().table("T_ARTICLE_CAT").set("C_ID",ID.next()).set("C_ARTICLE_ID",id).set("C_CAT_ID",cat).insert();
      }
    }else{
      t.getInserter().table("T_ARTICLE_CAT").set("C_ID",ID.next()).set("C_ARTICLE_ID",id).set("C_CAT_ID",1).insert();
    }
    t.commit();
    t.close();
    return new Tip("发布成功");
  }

  /**
   * 修改文章
   *
   * @return
   */
  public Object modify(){
    Request r = Context.get(Statics.REQUEST);
    long id = r.getLong("id");
    String title = r.get("title");
    String desc = r.get("desc");
    String content = r.get("content");
    String cats = r.get("cats");
    String pic = r.get("pic");
    String keywords = r.get("keywords");
    List<String> l = new ArrayList<String>();
    String[] cs = cats.split(",");
    for(String s:cs){
      s = s.trim();
      if(!s.equals("")){
        l.add(s);
      }
    }
    Validator.check(title,new RuleNotEmpty("标题"));
    HttpSession session = r.find(WebExecute.TAG_SESSION);
    User user = (User)session.getAttribute(Global.SESSION_USER);
    Logger.getLog().info(desc);
    ITrans t = TransFactory.getTrans();
    IUpdater iup = t.getUpdater().table("T_ARTICLE");
    iup.where("C_ID",id);
    iup.set("C_TITLE",title);
    iup.set("C_DESC",desc);
    iup.set("C_USER_ID",user.getId());
    iup.set("C_CONTENT",content);
    iup.set("C_PIC",pic);
    iup.set("C_KEYWORDS",keywords);
    iup.update();
    t.getDeleter().table("T_ARTICLE_CAT").where("C_ARTICLE_ID",id).delete();
    if(l.size()>0){
      for(String cat:l){
        t.getInserter().table("T_ARTICLE_CAT").set("C_ID",ID.next()).set("C_ARTICLE_ID",id).set("C_CAT_ID",cat).insert();
      }
    }else{
      t.getInserter().table("T_ARTICLE_CAT").set("C_ID",ID.next()).set("C_ARTICLE_ID",id).set("C_CAT_ID",1).insert();
    }
    t.commit();
    t.close();
    return new Tip("修改成功");
  }

今天在某著名群里贴了一个方法,结果下面有同学说:“不是挺清楚的?我觉得就不错。”

当时正在忙,没有时间详细介绍,于是决定晚上抽个时间给分析讲解一下,不能保证全部是对的,也不能保证全部能够被人接受,但是一定可以促进大家思考一些框架开发中的问题:

  1. 什么是框架?
  2. 到底设计的时候应该考虑哪些问题?
  3. 怎样才是一个及格的框架?

问题的解答

上面提出了三个问题,这三个问题说复杂也非常复杂,三天两天说不清楚;说简单也简单,一句话就说清楚了。

什么是框架?这个问题实际上许多“做框架”的人也不明白。

框架和库的本质不同在于:

  • 框架考虑的是机制的复用,而库主要考虑的是代码的复用
  • 框架考虑的是在机制不变的情况下进行扩展,而库则基本不考虑扩展方面的问题
  • 框架本身是不完整的,在大多数的情况下它自己是干不了啥事情的,而库自身是完整的,可以解决某个领域的问题。
  • 框架是活的,通过不断的扩展与衍生,它就更加强大,而库而是死的,发布时是怎样,就是怎样。

当然,关于这两货之间的比较,还有许多个角度,但我个人觉得本质是我上面举的这些。

设计的时候应该考虑哪些问题?这个问题的答案,如果用一句话来解符号,那答案就是:要仔细考虑使用这个框架的人感受,要考虑如何让使用者感觉爽的问题。当然如果是三天两天说不清楚的方式,那就得从方法论,问题领域,设计原则等待进行阐述了。

怎样才是一个及格的框架?这个问题,用一句话解释,就是在满足上一个问题的情况下不违背基本设计原则,那么就可以算是一个及格的框架。如果用三天两天说明,那就要把所有的基本设计原则拿出来,一个个讲讲清楚,一个个说说明白。

如果满足了第一个条件,使用者是满意的,从使用来说是不错的;如果满足了第二个条件来说,从设计及实现来说是不错的。如果两个都满足了那说明,最起码是可用的及格的框架,当然也可能得分更多。

代码分析

好的,上面大致讲了一个框架设计过程中要考虑的一些问题,下面就实质性的考虑一下上面的代码,我承认,我没有看里面“框架中具体的实现”,下面的全部“结论”其实都是我的一种判断或猜测,如有不对,欢迎指正:

  1. 这两个方法看起来是那么那么的相像,怎么看都不太协调
  2. Context看起来是个静态类,说明他一定有个ThreadLocal之类的东西在进行一些数据的存储,如果使用的是ThreadLocal其实还是有许多要注意的内容的,个人一般不太推荐采用这种方式进行数据传输。
  3. 数据获取:居然是通过request对象来直接读取值的,当然看得出来这个request作者已经进行了一些封装,但是显然,开发人员会对这个极度反感的。
  4. 事务处理:所有的处理都是自己在代码中写的,好吧,如果所有的业务都在一个方法中编写,那么是OK的,如果不是的话,就麻烦大了。
  5. 数据校验:也是在这个方法内部创建校验对象进行校验的,所以看到在两个方法中都有同样的代码来做同样的事情。
  6. 异常处理:没有看到异常处理方面的内容,因此不知道如果要操作的表不存时发生异常的时候,前台看到一个什么结果,是一大堆异常栈么?
  7. 函数声明:从函数的声明处是看不到传入和传出参数的,因此就决定了所有的处理都是要从上下文中获取Request,Session啥的自己把数据搞出来的。它的返回值是Object,这说明啥意思呢?说明在Jsp展现里应该是进行类型强转的。
  8. 代码重复:由于事务都是写在方法里的,也就说明这些方法不能重用,许多代码都要重复编写。
  9. 处理能力扩展:由于数据库处理与业务展现放在一起,说明是一个典型的B/S架构,也就是说处理能力是非常容易估算的,而且进行水平扩展的能力也比较有限。也说明 系统的安全性比较弱(数据库与应用服务器在同一层上,如果攻破了应用服务器,就会有倒库行为的发生)
  10. 事务对象:有一个疑问:t.commit中为什么还要执行一个t.close?如果commit的时候发生一个异常,到底是close上没有?如果没有close上,外面异常处理怎么处理?

再来分析一下它里面违反一些常见现象对象设计原则的点:

单一原则:在一个方法里做了太多的事情,这种代码以后改的时候有多累呀

抽象原则:没有独立的Dao及Pojo,没有把Dao层,业务层进行剥离,从而导致数据的验证要重复的进行,这块的处理也不能进行复用。可以想想,如果想让这两方法提供的添加和修改功能通过Json或WebService对外提供服务,程序员唯一可行的办法就是再写两方法。

DRY原则:不要做重复的工作,代码中的重复实在太多了,这一点有可能是笔都只是为了说明意思或者随意了。

自动原则:如果能程序化自动完成的,不要让程序员手动完成。

总结

只看这两段代码总结出来的内容不一定全部正确,如果有不正确的地方,欢迎海涵并批评指正。

其实之所以对这两段代码进行分析,是经过作者同意的,一来这两段代码比较典型,可遇而不可求,另外也希望代码作者能够高调做事,低调做人,扎扎实实做出一个别人无法进行再优化改良的框架来。

时间: 2024-10-10 22:01:03

悠然乱弹:从一段代码讲开去的相关文章

悠然乱弹:一段SQL引发的性能危机及其背后隐藏的设计缺陷

有个同学,说是系统中出现性能问题了,说是让我帮助诊断一下.本来是不想花这时间的,结果耐不住对方的死缠乱打,只要答应帮看看. 故事发生的背景是,在文件上传的时候,有时间会有人上传了文件,但是最后没有使用上传的文件,这样就会产生一些垃圾文件. 原来软件作者就想写一个后台定时任务程序,来清除这些垃圾文件? 由于作者坚定的不让我发她的SQL语句(这个我也理解,这么丑陋的SQL),所以这里就不发源代码了,发伪代码. void deleteMissLinkFile{ List fileList=getFil

《开源框架那些事儿27》悠然乱弹:一段SQL引发的性能危机及其背后隐藏的设计缺

有个同学,说是系统中出现性能问题了,说是让我帮助诊断一下.本来是不想花这时间的,结果耐不住对方的死缠乱打,只要答应帮看看.  故事发生的背景是,在文件上传的时候,有时间会有人上传了文件,但是最后没有使用上传的文件,这样就会产生一些垃圾文件. 原来软件作者就想写一个后台定时任务程序,来清除这些垃圾文件? 由于作者坚定的不让我发她的SQL语句(这个我也理解,这么丑陋的SQL),所以这里就不发源代码了,发伪代码. 123456789101112131415 void deleteMissLinkFil

这段代码哪里内存溢出了呢?

原文出自:方杰|http://fangjie.sinaapp.com/?p=184转载请注明出处 最终效果演示:http://fangjie.sinaapp.com/?page_id=54 该项目代码已经放到github:https://github.com/JayFang1993/SinaWeibo 一.首先是ListView的adapter. 因为微博列表的Item不是规则的,比如说有些微博有转发子微博,有些没有,有些有图片,有些没有图片,所以说很不固定.这里就采用BaseAdapter,要

java中 synchronized 的使用,确保异步执行某一段代码。

最近看了个有关访问网络url和下载的例子,里面有几个synchronized的地方,系统学习下,以下内容很重要,记下来. Java语言的关键字,当它用来修饰一个方法或者一个代码块的时候,能够保证在同一时刻最多只有一个线程执行该段代码. 一.当两个并发线程访问同一个对象object中的这个synchronized(this)同步代码块时,一个时间内只能有一个线程得到执行.另一个线程必须等待当前线程执行完这个代码块以后才能执行该代码块. 二.然而,当一个线程访问object的一个synchroniz

悠然乱弹:竹子与开源:扎根是为了长得更高

端午节到了,人们都在讨论屈原不屈不挠的精神,以及龙舟.粽叶等世界文化遗产.粽叶清淡,给人无限的遐想.或者,你很容易想起和粽叶形状比较类似的竹叶,以及屹立挺拔的骨感竹子.竹在清风中瑟瑟的声音,在夜月下疏朗的影子,都让文人墨客深深感动.而竹于风霜凌厉中苍翠依然的品格,更让诗人引为同道.苏东坡曾在<于潜僧绿筠轩>里宣称,"宁可食无肉,不可居无竹.无肉令人瘦,无竹令人俗.人瘦尚可肥,士俗不可医."当年郑板桥曾作<竹石>,细细品味,也给人许多思考. 作为开源参与者,其实我

当程序员说“这代码写的可真烂”,他们的意思是“这烂代码不是我写的”。而当他们说这段代码有些“小问题”时,很可能这代码是他们自己写的

英文原文:What Programmers Say vs. What They Mean 你是否听到过同事说“这段代码不言自明”?你的同事的这句话的实际意思是这段代码不需要写注释. 你也许注意到了,很多时候,程序员所说的话的字面意思和其真实的意思是完全不同的.不用惊异,下面你将很快知道这些暧昧的短语和其深层次的意思都是什么. 最近 Imgur 上出现了一张图片,里面列举的程序员的一些专业术语和其含义,它能很好的帮助你理解这些话的真实意思.这里是对其中的精华进行的总结. 典型的程序员之间的对话 当

关于hrtimer_forward小段代码的分析【转】

转自:http://blog.csdn.net/wowuyinglingluan/article/details/45720151 版权声明:本文为博主原创文章,未经博主允许不得转载. 目录(?)[-] 整段代码 关于无效的forward 关于定时精度问题 精确调整和overrun问题 存疑 随着各种嵌入式设备上采用linux,特别是Android系统的广泛应用,linux的hrtimer高精度模式开始被广泛支持.当然,虽说可以支持到ns精度,具体实现依赖于硬件定时器和内核编译条件,不过,一般情

悠然乱弹:论“轮子党”的邪恶面

什么叫轮子党呢?这里给出一个泛泛的定义,轮子党,就是看到开源作者做的作品之后,干净利索的在后面附着两字:轮子.当然现在也有一些新的变体,比如:发一条"然并卵".但是不管现在怎么变,将来怎么变,其基本涵义就是说:你做的东西没有什么意义,或者说你做了也是重复人家的东西. 但是最要命的是,这些轮子党在给出这些结论之前,没有任何分析.没有任何研究,他特么一个结论丢在那里,让开源作者在那里心中产生千万个草泥马在奔腾. 所以今天我就写这篇乱弹,来正告那些轮子党,为啥不是"轮子"

由一段代码解析系统调用的原理

朱宇轲 + 原创作品转载请注明出处 + <Linux内核分析>MOOC课程http://mooc.study.163.com/course/USTC-1000029000 在本次的实验中,我们将通过用C和汇编实现的同样一段代码来解析系统调用的过程. 废话少说,开始实验! C语言程序如下所示: /*test.c*/#include<sys/types.h> #include<sys/stat.h> int main() { int status; int type=S_I