BlogJava-子在川上曰-随笔分类-项目日记

"知识管理及信息传递"是项目成功的关键点

陈刚 — Wed, 30 Aug 2006 01:31:00 GMT

公司项目太庞大了（30多个子项目，数百万行的代码），在最近的系统大重构后，版本发布推迟了两月。老大让我提提意见，于是我提了如下意见。

代码质量

定期Code review。总结他人经验，学习他人之长。
开放maven的单元测试。一步步来，至少要强制性的要求每远程交互接口都有单元测试代码。同时，单元测试代码也要为code review的一部份。

知识管理及信息的有交传递

知识管理及信息的有效传递的效率低下，我认为这是本次版本发布延期的根本原因。为此我提出以下建议：

一、利用google的桌面搜索，让信息获取的简单、快速、全面。实现步骤如下：

1. 在局域网内创建一个专用于文档的共享文件夹。

2. 文件夹中存在公司所有文档，最好是分类分目录存放

3. 在文件共享服务器上安装一个网页抓取器，把jira上的信息每天抓取保存。

4. 各同事的在自己的电脑里创建一个“公文包”，将局域网的文件复制到本机公文包中。

5. 各同事定期更新公文包

6. 各同事在本机安装GOOGLE的桌面搜索。

7. 将公文包设置到GOOGLE的桌面搜索

8. 将本机项目源文件目录，以及一切你自己的文档设置到GOOGLE的桌面搜索

9. 在初始化时google会花一些时间去创建搜索库，之后再用就会很快了。

10. 各同事如果在工作中遇到问题，使用GOOGLE的桌面搜索，就可以全面快速的搜索到你想要的资料。

实现过程详见，操作视频：\\corpserver\share\software\google\GoogleDesktopEnterprise.avi

陈刚 2006-08-30 09:31 发表评论

[项目日记] 源代码管理出现麻烦

陈刚 — Sat, 29 Apr 2006 00:30:00 GMT

这个月Neil回加拿大休假三周。谁知，他一走系统就出现了问题，一些紧急的新需求又接踵而来。程序员忙于Fix Bug实现新需求，一晃眼，出现了三个CVS活动分支，程序员把代码都在分支上修改和fix。现在的结果是，源代码变得难以控制，分支上fix的bug在主干上没有fix，你要保证主干＋三分活动分支上都fix bug谈何容易，源代码乱成了一锅粥。

Neil回来后专门就此事开了一个会，参考现在Open Source流行的做法，定下了这样的做法和原则：

（1）每发布一个版本，打一个分支，用分支固定住代码。然后，在这个分支进行版本分布。
（2）所有fix bug都应在主干上，保证主干上的代码永远是最新。
（3）如果分支的分布版本（也是正在生产系统工作的版本），出现严重bug，则在分布上打一个Patch，而不是在分支上fix bug，分支上代码是应该被冻结的。如果不是严重到必须要fix，则bug应该等到下一个发布版本。
（4）新需求不能在分支上代码添加，要在主干上实现，并在下一个版本分布。
（5）根据新需求的数量要紧急程序，加快新版本的发布步骤（由原来三个月，改为一个月）。增加测试员（现2人，再增2人）。

越来越有点敏捷的开发方式的味道了。我提出要着手推行自动单元测试，这样才能以支撑住快的发布频率。Neil同意，但并没有采纳，只建议程序员尽量写自动单元测试。

效果如何，下一步会怎么样，轼目以待吧。

陈刚 2006-04-29 08:30 发表评论

给RCP系统添加全局快捷键

陈刚 — Fri, 28 Apr 2006 13:35:00 GMT

文/陈刚 from www.chengang.com.cn　at 2006年4月28日

一个RCP系统，给它添加一个象Eclipse中Ctrl+Shift+O一样的全局快捷键，怎么加？

参考了RCP的Email项目示例，给我RCP项目中MonitorAction（显示一个监视器的命
令）添加一个快捷键Ctrl+1。简单把添加的过程概述如下：

1、首先在plugin.xml中添加两个扩展点如下

   <extension
         point="org.eclipse.ui.bindings">
      <key
            commandId="org.eclipse.ui.file.exit"
            schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
            sequence="CTRL+X"/>
      <key
            commandId="adminconsole.monitor"
            schemeId="org.eclipse.ui.defaultAcceleratorConfiguration"
            sequence="CTRL+1"/>
   extension>

   <extension
         point="org.eclipse.ui.commands">
      <category
            id="adminconsole.perspective"
            name="Perspective"/>
      <command
            categoryId="adminconsole.perspective"
            id="adminconsole.monitor"
            name="Open Monitor Perspective"/>
   extension>

说明：
。org.eclipse.ui.file.exit是另一个退出系统命令，是复用了Eclipse本身的那个，它和本例无关。
。commandId要求唯一
。cmmands扩展点的category是一个组，估计不要也可以，最后还是加上吧。
。bindings扩展点中的commandId对应于cmmands扩展点中的id

2、创建一个类，专门保存所有commandId

public interface ICommandIds {
public static final String CMD_MONITOR = "adminconsole.monitor";
}

3、创建Action类，在构造函数里用两个方法注册一下

    private static class MonitorAction extends Action {
        public MonitorAction() {
            setText("监视");
            // The id is used to refer to the action in a menu or toolbar
            setId(ICommandIds.CMD_MONITOR);
            // Associate the action with a pre-defined command, to allow key bindings.
            setActionDefinitionId(ICommandIds.CMD_MONITOR);
        }

        ...
    }

4、在ApplicationActionBarAdvisor的makeActions方法，给monitorAction对象加上这样一句

注意：如果你没有在plugin.xml和makeActions做上面讲过的设置，加上这一句将可能导致
你的RCP系统无法启动。

陈刚 2006-04-28 21:35 发表评论

RCP中包更新后的处理

陈刚 — Thu, 27 Apr 2006 02:33:00 GMT

我gef、emf的包还是以前老的，现在用的是Eclipse 3.2M6，于是去eclipse.org下载了相应版gef/emf，更新一下。

这一更新问题来了，项目运行不起来了。报名application id找不到（或product找不到，记不太清）。以下是处理的过程。

（1）把????.product依赖包重新弄了一遍。不行。
（2）把run..中的依赖包重新弄了一遍，用run来运行。成功。
（3）通过????.product的项目导出功能，导出项目后运行。运行失败。
（4）嗯，可能是????.product中依赖包没有调整。于是和（1）一样重新弄了依赖包。再次导出项目还是不行。并且用run来运行，又失败了。
（5）看来run..对????.product没有影响，????.product反过来对run..里的设定产生的影响。
（6）重做了（2）步，再删除????.product，重新生成????.product。所有问题都解决，运行成功，项目导出后也运行成功。

总结，看来更新依赖包后，至少要做以下处理
（1）在run..中调整依赖包.
（2）重建???.product文件。

陈刚 2006-04-27 10:33 发表评论

[TDD开发的全过程] 三、抽取公共类

陈刚 — Wed, 19 Apr 2006 07:22:00 GMT

文/陈刚 at 2006年4月19日 from http://www.chengang.com.cn

一、前言

在前面一章中，我有这样的想法。

在这里我面临一个选择，是先写界面呢？还是先写底层API？我想，先写界面很难写测试代码，而且界面在设计时已经定下来了，基本不会变了

后来我又想，界面固然变化很少了，但界面内容需要调用的后台API却是未曾定型，所以如果在TDD时从界面写起也许更合适，因为界面本身和测试用例一样，也算是后台API的一个用户。

在写SWT的界面很烦的是无法应用TDD，甚至无法写自动单元测试代码。单元测试在界面开发中显得特别无力，在<>这本书中虽然说到JSP的测试，但Swing的自动测试没有提及，更不要说SWT了。我曾多方寻找SWT的自动测试框架，在eclips.org上有eclipse-test-framework，不过使用很复杂，至今还没怎么搞懂。虽然界面测试很困难，但我们还是可以通过一些小技术来加速界面开发，和进行半自动测试的。

不过本篇且不是讲SWT界面的测试的，这里只是临时记下自己的一些想法。这篇主要讲的抽取公共类。

二、抽取公共类类

TDD有一个基本思想：拒绝代码的复制/粘帖。也就是说一段相同的代码，在项目中应该只存在一处。同理，从更高处来说，几个项目中常用的类也应该只存在于一处。其实，我们平时编程就已经发现很多类和代码是通用的，不过我们依然习惯于去老项目中翻看代码，然后复制粘贴于新项目中来。这样的做法是违反TDD“拒绝代码的复制/粘帖”原则的，所以在平时我们就应该注意提炼自己的公共代码库，说不定几年后我们就能形成自己的一个框架，很多框架和类库不就是这样形成的吗，比如 appache 的commons系列，比如Struts、比如Spring。

今天我抽取的公共类是一个图标闪烁类，和一个时间显示Label。如下图，图中上部左边的“邮件图标”和右边的“时间显示”，可以抽取出来做成公共类，在各种SWT项目中使用。特别是邮件图标的闪烁显示，因为SWT还不支持动态GIF，所以只能用多线程轮换图片的方式来实现图标闪烁，我想这样的类提取出来，用作还是挺大的。

三、FlashImage类

这里没有让FlashImage 继承自Label，而是内嵌了一个Label。这是应用于组合优先于继承的原则，并且Label是不可继承的，虽然SWT中并没有把它定义成Final ，但却会在其内部做一个子类检查，如果是继承自Label则会报出异常。和Label一样的还是Shell，虽然没有final 修饰符，但也是不可继承的。

这里还涉及SWT的多线程编程，在停止线程时不能用Thead#stop方法的，这个方法已经禁用了。另外，线程要在label#dispose后也关闪掉，所以在label加了一个disponse的事件监听。

package cn.com.chengang.myswt;

import org.eclipse.core.runtime.Assert;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.MouseListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;

import cn.com.chengang.common.util.CommonUtil;

public class FlashImage {
    private Label flashLabel;
    private Image stopImage;
    private Image[] flashImages;
    private long flashSpaceTime = 100; //闪动间隔时间

    private boolean progressStop = true; //处理是否停止的标志

    /**
     * @param comp
     * @param style 与Label的style相同
     * @param flashImages 闪动的图像
     * @param stopImage 停止时的图像
     */
    public FlashImage(Composite comp, int style, Image[] flashImages, Image stopImage) {
        Assert.isTrue(flashImages != null && flashImages.length != 0);
        flashLabel = new Label(comp, style);
        this.flashImages = flashImages;
        this.stopImage = stopImage;
        flashLabel.setImage(stopImage);
        //监听Dispose事件,在其销毁时停掉线程
        flashLabel.addDisposeListener(new DisposeListener() {
            public void widgetDisposed(DisposeEvent e) {
                progressStop = true;
            }
        });
    }

    /**
     * 开始闪动
     */
    public void flash() {
        if (!progressStop)
            return;

        progressStop = false;
        new ImageFlashThread().start();
    }

    /**
     * 停止闪动
     */
    public void flashStop() {
        progressStop = true;
    }

    /**
     * 设置闪动间隔的时间
     * @param time 默认100(100毫秒)
     */
    public void setFlashSpaceTime(long time) {
        this.flashSpaceTime = time;
    }

    private Display getDisplay() {
        return Display.getDefault();
    }

    public void addMouseListener(MouseListener listener) {
        flashLabel.addMouseListener(listener);
    }

    /**
     * 闪动图像线程
     */
    private class ImageFlashThread extends Thread {
        public void run() {
            int i = 0;
            while (!progressStop) {
                if (i == flashImages.length)//到头循环
                    i = 0;
                setCurrentImage(flashImages[i]);
                CommonUtil.sleep(flashSpaceTime);//闪动间隔
                i++;
            }
            setCurrentImage(stopImage);
        }

        private void setCurrentImage(final Image image) {
            getDisplay().asyncExec(new Runnable() {
                public void run() {
                    flashLabel.setImage(image);
                }
            });
        }
    }

}

给出一个客户端使用的示例：

                Image[] flashs = new Image[] {
                        ImagesContext.getImage(ImagesContext.MAIL),    //ImagesContext是我自己写的一个管理Image的类
                        ImagesContext.getImage(ImagesContext.MAIL_GRAY) };
                Image stopImage = ImagesContext.getImage(ImagesContext.MAIL);

                flashImage = new FlashImage(c, SWT.NONE, flashs, stopImage);
                flashImage.setFlashSpaceTime(800);
                flashImage.addMouseListener(new MouseAdapter() {
                    public void mouseDown(MouseEvent e) {
                            //do something......
                    }
                });

四、TimeLabel类

时间显示Label则和FlashImage类似，可以说是它的一个简化版

package cn.com.chengang.myswt;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;

import cn.com.chengang.common.util.CommonUtil;

/**
* @author chengang 2006-4-19
*/
public class TimeLabel {
    private Label timeLabel;
    private long flashSpaceTime = 480; //闪动间隔时间
    private boolean progressStop = false; //处理是否停止的标志
    private DateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");

    public TimeLabel(Composite comp, int style) {
        timeLabel = new Label(comp, style);
        timeLabel.setText("sssssssssssssssssss");
        //监听Dispose事件,在其销毁时停掉线程
        timeLabel.addDisposeListener(new DisposeListener() {
            public void widgetDisposed(DisposeEvent e) {
                progressStop=true;
            }
        });
        new ShowTimeThread().start();
    }

    public void dispose() {
        progressStop = true;
    }

    private Display getDisplay() {
        return Display.getDefault();
    }

    private class ShowTimeThread extends Thread {
        public void run() {
            while (!progressStop) {
                String str = dateFormat.format(new Date());
                setText(str);
                CommonUtil.sleep(flashSpaceTime);//闪动间隔
                       //CommonUtil是我自己写的一个常用工具方法类，sleep的代码如下
                       //public class CommonUtil {
                       //    public static void sleep(long millis) {
                       //        try {
                       //            Thread.sleep(millis);
                       //        } catch (InterruptedException e) {
                       //            e.printStackTrace();
                       //        }
                       //    }
            }
        }

        private void setText(final String time) {
            getDisplay().asyncExec(new Runnable() {
                public void run() {
                    timeLabel.setText(time);
                }
            });
        }
    }

    public void setLayoutData(GridData data) {
        timeLabel.setLayoutData(data);
    }

    public void setDateFormate(DateFormat format) {
        dateFormat = format;
    }

}

客户端的使用代码示例：

                TimeLabel timeLabel = new TimeLabel(topComp, SWT.NONE);
//                timeLabel.setDateFormate(new SimpleDateFormat("HH:mm:ss"));
                timeLabel.setLayoutData(new GridData(GridData.END, GridData.CENTER, true, true));

作者简介

陈刚，广西桂林人，著作有《Eclipse从入门到精通》
您可以通过其博客了解更多信息和文章：http://www.ChenGang.com.cn
版权声明：本博客所有文章仅适用于非商业性转载，并请在转载时注明出处及作者的署名

陈刚 2006-04-19 15:22 发表评论

[TDD开发的全过程] 二、开发PhoneManager等类

陈刚 — Thu, 13 Apr 2006 05:59:00 GMT

摘要: 文/陈刚 at 2006年4月13日　from www.ChenGang.com.cn一、前言今天我把文章的名称改了一下，想把它写成关于TDD实践的一系列文章。前一篇是设计，这一篇开始是开发。TDD我是闻名已久，在过去实际开发中也经常用junit来写单元测试，但真正的TDD却从来没有尝试过。不过单元测试写得久了，发现TDD确实有它诱人的地方，也许它真的可以带我领略一个新的编程世界。于是，又再次翻开... 阅读全文

陈刚 2006-04-13 13:59 发表评论

[TDD开发的全过程] 一、设计阶段

陈刚 — Wed, 12 Apr 2006 08:51:00 GMT

　　　　　　　　　　　　文/陈刚 at 2006年4月12日　from www.ChenGang.com.cn

前段时间把一个界面框架完成了，今天基于这个框架开发一个小模块，在这里把这个模块设计的全过程记录下来，希望大家讨论并指正。

一、起因

公司交给我一个任务，为测试员写一个手机模拟界面，以方便她们的手机短信测试。过去她们都是用MC4J直接调用公司服务器的MBean服务来模拟进行测试，以验证我们整个系统平台。这种测试主要是检查收发短信是否正常，而我的要做的工作就是，让她们在测试的时候更方便更直观。

二、需求

我和测试员陈MM（也就是软件的使用者）约定了一个时间，大家一起来讨论这个软件的需求。

1、首先，我大概了解了一下她们的测试工作，知道我要做个什么东东。

2、然后我回去思考了一下，再次找她详细了解其测试的具体步骤，并在一张白纸上以UML用例图的方式，记录下需求的功能。用例是什么？用例就是需求，就是你的软件应该具有的功能，当然用例图只是概括性的对功能进行了描述。

3、最后，我坐在我的电脑前开始用MagicDraw UML来画用例图（我不喜欢用Rose，那玩意太笨重了，界面友好性也不好）。在画用例图的时候，我发现了一些隐含的功能，这些是陈MM在和我做需求时没有考虑到的（注：开发者应该为用户挖掘隐含需求）。我和陈MM一一确定了这些我新发现的需求，最后得到如下的用例图。

（1）手机前台测试操作的用例图（说明：include是指某用例包含(include)子用例）

（2）后台管理

三、界面设计

接下来是界面设计。既然是手机模拟，我很自然就拿我的motorola手机的操作界面来做参考。不过这里应该注意到，手机操作环境和电脑操作环境不尽相同（比如说电脑有鼠标，还有键盘可以输入文字），所以没有必要唯妙唯肖的完全模枋，还是以使用者操作方便为主。

界面设计是很重要的一步，不要一上来就写程序，一定要先做到心中有个大概，否则返工的可能性就很大。而且，把界面拿出来给客户看，客户也就能做到心中有数，还能尽早提出一些新需求和意见来。千万不要等到软件做完了再拿给客户看，到时客户看了如果要修改，那就做太多白费工了。

由于软件界面相对简单，陈ＭＭ基本没有提修改意见，但这不是个好兆头。不过极限编程就是要拥抱变化不是^_^。咱不怕她改，只要大致的界面她能定下来就行了。

界面我喜欢用Visio来画，当然也听说有人喜欢用ＶＢ来快速构建界面原型的，看个人喜好了。整个界面如下：

这个是后台管理界面

四、类图

类图反映了软件的数据模型。在设计数据模型，我参考了界面设计图和用例图，找出一个个的类。然后参照用例图的一个个功能，设计出了各类的属性和方法。设计初始的类图当然不可能很详细，但至少应该看到个大概。有错误不要紧，后期可以慢慢修正，但大体关系就算定下来了。

Neil（公司ＣＴＯ，一个40岁左右的真正的资深程序员）说：看一个软件的设计主要看两个类：类图和时序图。类图确定了软件数据模型的静态关型，时序图则是数据模型的动态关系。

类图如下，看英文大致可以知道类／属性／方法的含义和作用了，就不一一介绍了。

五、时序图

时序图是本文最后一个图，时序图表明了用例图中各功能的实现方案，同时也反应了类图中各类的交互关系。以后程序的逻辑和时序图基本一致。不过，有些人会去画得很详细的时序图，详细到都快赶上伪代码级别了，我觉得这没必要。我把时序图看做反映自己思路的大概过程，所以也就画个大概。

我认为时序图要简洁易懂，这样以后你的后继维护者，拿到这个软件的时序图（当然也包括用例图、类图），就能明白你的大概设计思路。另外，画时序图也能整理自己的思路，同时还可以对类图的设计进行验证。在画这个时序图的过程中，我就纠正了在类图中的几处考虑不周的地方。

总结：时序图可以（１）整理思路（２）验证类的设计（３）是很好的软件文档，对维护者理解代码很有帮助。

这里仅给出其中几个时序图（实际上我也没有把用例都画完，有些类似的简单的，就忽略了）

（１）新增一个手机号码

（２）关机

（３）开机

（４）发送短信

到这里设计阶段就完成了，用时一天。下一步是编码，将应用ＴＤＤ先写测试代码的方式来写代码，下次再介绍了。

作者简介

陈刚，广西桂林人，著作有《Eclipse从入门到精通》
您可以通过其博客了解更多信息和文章：http://www.ChenGang.com.cn
版权声明：本博客所有文章仅适用于非商业性转载，并请在转载时注明出处及作者的署名。

陈刚 2006-04-12 16:51 发表评论

一个界面框架的设计

陈刚 — Tue, 14 Mar 2006 01:48:00 GMT

摘要: 一个图形界面框架的设计，包括了它的用例图、类图、时序图，以及相应的说明。阅读全文

陈刚 2006-03-14 09:48 发表评论