hypercube1024

Seam 使用心得（二）接口实现

hypercube1024 — Wed, 19 Dec 2007 20:59:59 +0800

作者: hypercube1024 链接：http://hypercube1024.javaeye.com/blog/149527 发表时间: 2007年12月19日

声明：本文系JavaEye网站发布的原创博客文章，未经作者书面许可，严禁任何网站转载本文，否则必将追究法律责任！

Java里提倡使用面向接口编程以减弱组件之间的耦合，在上一篇里已经定义了

@Local
public interface Register {
	public String register();
}

这一节里面将实现这个接口来通过测试。

现在应用系统有很多良好的分层方法，但是我还是喜欢Evans的领域驱动设计的方法。
1,视图层将使用RichFaces。
2,使用无状态SessionBean作为Facade对领域逻辑进行封装。
3,领域层实现核心业务逻辑，主要包括有实体，值对象，仓库，服务等。

源文件目录结构大致如下：
src
|----action (SLSB)
|----model (Service, Entity, Repository, Vo)
|----test
view
|----css
|----js
……

经过简单的分析model层向facade暴露UserView接口

package org.qpt.domain.user;
import org.qpt.domain.user.User.RegState;
/**
 * 用户接口
 * @author xiaoqiu
 */
public interface UserView {
    String getConfirmPwd();
    String getEmail();
    String getName();
    String getPwd();
    /**
     * 注册一个新用户
     * @param ur 用户仓库接口
     * @return 注册结果状态码(共5种状态，上一节已经提到过)
     */
    RegState register(UserRepository ur);
    void setConfirmPwd(String confirmPwd);
    void setEmail(String email);
    void setName(String name);
    void setPwd(String pwd);
}

注：因为EJB2严重的依赖于容器的基础设施，如果在实体bean中包含业务逻辑，将很难进行测试，所以实体bean只能作为数据容器，而背离面向对象的分析和设计方法。但是EJB3已经可以对实体进行透明持久化，并且很容易在容器外进行测试，所以就用User实体实现UserView接口，这里用户注册的并没有跨越多个实体，只涉及用户实体，所以包含了业务方法register的User类代码如下：

/**
 * 用户实体
 * 
 * @author xiaoqiu
 */
@Entity
@Name("user")
@Scope(SESSION)
@Table(name = "users")
public class User implements Serializable, UserView {

    private static final long serialVersionUID = 3836699581343986461L;
    @Id
    @NotNull
    @Length(min = 6, max = 15)
    private String name;
    @NotNull
    @Length(min = 6, max = 15)
    private String pwd;
    @Transient
    private String confirmPwd;
    @NotNull
    @Email
    private String email;
    @Transient
    private String confirmEmail;

    public enum RegState {
        EXISTS_EMAIL, EXISTS_NAME, PWD_NOT_EQ_IN_TWICE, EMAIL_NOT_EQ_IN_TWICE, SUCCESS
    }

    @Override
    public RegState register(UserRepository ur) {
        if (!pwd.equals(confirmPwd)) {
            return PWD_NOT_EQ_IN_TWICE;
        } else if (!email.equals(confirmEmail)) {
            return EMAIL_NOT_EQ_IN_TWICE;
        } else if (ur.findByProperty("name", name)) {
            return EXISTS_NAME;
        } else if (ur.findByProperty("email", email)) {
            return EXISTS_EMAIL;
        } else {
            ur.save(this);
            return SUCCESS;
        }
    }

……
get&set method
}

考虑到视图层RichFaces和hibernate验证结合可以进行很简单的零脚本ajax验证，所以本例子里面使用了hibernate验证。
由于register方法需要用的UserRepository来访问数据库，所以现在来看一下UserRepository接口。通过隔离基础设施，这就是GOF设计模式中著名的Strategy模式，由于Java语言想要在实体中注入UserRepository在技术上存在困难，所以把UserRepository作为方法的参数传递我个人认为也是一种较为简洁的方法，而且通过接口的隔离不会和基础设施产生强烈的耦合，UserRepository代码如下：

/**
 * 用户仓库接口
 * @author xiaoqiu
 */
@Local
public interface UserRepository {
    void save(User user);
    User findByName(String name);
    List findAllUser();
    /**
     * 找出该属性是否存在当前值
     * @param name 属性名
     * @param value 属性值
     * @return 该属性存在这个值返回true，否则返回false
     */
    boolean findByProperty(String name, String value);
}

在本例里面UserRepository的实现使用的JPA，这个接口的实现相当容易所以它的实现类UserRepositoryJPAImp代码就不贴出来了，可以直接看提供的源码。

model层的接口已经实现完毕，接下来实现facade，代码如下：

@Stateless
@Name("register")
public class RegisterBean implements Register {

    @Logger
    private Log log;
    @In
    FacesMessages facesMessages;
    @In
    private UserView user;
    @In("userRepository")
    UserRepository ur;

    public String register() {
        RegState state = user.register(ur);
        switch (state) {
            case PWD_NOT_EQ_IN_TWICE:
                log.info("the register state is " + state);
                facesMessages.addFromResourceBundle("myapp.register.pwd.noteq");
                break;
            case EMAIL_NOT_EQ_IN_TWICE:
                log.info("the register state is " + state);
                facesMessages.addFromResourceBundle("myapp.register.email.noteq");
                break;
            case EXISTS_NAME:
                log.info("the register state is " + state);
                facesMessages.addFromResourceBundle("myapp.register.name.exists");
                break;
            case EXISTS_EMAIL:
                log.info("the register state is " + state);
                facesMessages.addFromResourceBundle("myapp.register.email.exists");
                break;
            case SUCCESS:
                log.info("register a new user #{user.name}" + "\nthe register state is " + state);
                facesMessages.addFromResourceBundle("myapp.register.success");
                break;
        }
        return state.toString();
    }
}

这里facade是很薄的一层，不能包含任何业务逻辑，它主要根据model返回的状态是向显示层发送信息，使用facesMessages组件就可以很容易向Richfaces发送ajax验证的响应信息，并且事务处理统一在facade层进行，由于使用EJB，所以就可以使用容器提供的事务管理。

上述类的结构如下图所示：
facade: Register-->RegisterBean-->UserView&UserRepository
domain:UserView-->User(Eneity)<-->UserRepository-->UserRepositoryJPAImp
至此为止，注册用户所需要的全部接口都已经实现，现在就可以用seam test命令来运行上一节写好的测试代码了。
本文的讨论也很精彩，浏览讨论>>

JavaEye推荐

Seam 使用心得（一）测试先行

hypercube1024 — Wed, 19 Dec 2007 12:15:08 +0800

作者: hypercube1024 链接：http://hypercube1024.javaeye.com/blog/149377 发表时间: 2007年12月19日

声明：本文系JavaEye网站发布的原创博客文章，未经作者书面许可，严禁任何网站转载本文，否则必将追究法律责任！

最近开始关注Seam，正值Seam2.0发布之际我也下载来试用，还是准备先做一个用户注册的例子。由于一直喜欢TDD所以先从测试用例开始写起吧。
首先使用seam-gen生成一个项目目录，然后再进行必要的配置。
1)配置数据源，我使用的hsqldb内存数据库，这样比较方便
在myApp-test-ds.xml这样进行配置


   
        myAppTestDatasource
        jdbc:hsqldb:.
        org.hsqldb.jdbcDriver
        sa

persistence-test.xml中的配置


      org.hibernate.ejb.HibernatePersistence
      java:/myAppTestDatasource

这样测试数据源的配置就完成了，当然还要把hsqldb.jar放在测试的classpath中。

2)配置测试用例
在测试文件夹中创建一个用于配置测试用例类的xml，我的就是在test/org/qpt/test/user里面建立一个RegisterTest.xml，内容如下：

3)检查你的build.xml中test任务是否正确的拷贝了测试所有需要用到的jar包和xml文件,我的build.xml是用seam-gen自动生成的，有些文件例如dataset.xml模拟数据库的标准数据的文件就没有被自动拷贝到相应的目录导致运行测试就报异常，我为此郁闷了好几天，网上一直找不到答案，结果静下心仔细研究了一下才发现build.xml的问题-_-!，所以我在build.xml加入了如下任务：

4)编写测试用例
一般来说用户注册要调用一个register()的业务方法，所以我的无状态session bean接口如下：

package org.qpt.facade;
import javax.ejb.Local;

@Local
public interface Register {

    /**
     * 注册一个新用户
     * @return 状态码有5种情况：1,注册成功(SUCCESS)
     * 2,两次输入的密码不同(PWD_NOT_EQ_IN_TWICE)
     * 3,两次输入的email不同(EMAIL_NOT_EQ_IN_TWICE)
     * 4,用户名已经在数据库里面存在(EXISTS_NAME)
     * 5,email已经在数据库里面存在(EXISTS_EMAIL)
     */
    public String register();
}

返回的状态码可以用enum来实现，如：

public enum RegState {
        EXISTS_EMAIL, EXISTS_NAME, PWD_NOT_EQ_IN_TWICE, EMAIL_NOT_EQ_IN_TWICE, SUCCESS
}

现在就可以在org.qpt.test.user.RegisterTest类里面开始编写测试用例了，但是由于使用了ejb所以现在要用到嵌入式jboss，要把jboss-embedded-all.jar放到测试的classpath中。(注意：根据官方文档的说明，嵌入式jboss只能在jdk1.5下面使用，如果使用的jdk1.6将报异常，但是经过搜索官方网站已经发现了解决方案，那就是要下载一个新的org.jboss.metadata.spi.signature.Signature类重新编译后覆盖原始的，这个类的源文件在最后附上)

下面的代码是测试代码的一部分，完整的代码应该验证register方法返回的5种状态：

public class RegisterTest extends DBUnitSeamTest {// 1
@Override
    protected void prepareDBUnitOperations() {
        beforeTestOperations.add(new DataSetOperation("org/qpt/test/user/RegisterDataSet.xml")); // 2
    }
	......
@Test
    public void testCorrectCase() throws Exception { //3
        new FacesRequest() {

            @Override
            protected void updateModelValues() {
                setValue("#{user.name}", "qwerty");
                setValue("#{user.pwd}", "123456");
                setValue("#{user.confirmPwd}", "123456");
                setValue("#{user.email}", "qwerty@123.com");
                setValue("#{user.confirmEmail}", "qwerty@123.com");
            }

            @Override
            protected void processValidations() {
                validateValue("#{user.name}", "qwerty");
                validateValue("#{user.pwd}", "123456");
                validateValue("#{user.confirmPwd}", "123456");
                validateValue("#{user.email}", "qwerty@123.com");
                validateValue("#{user.confirmEmail}", "qwerty@123.com");
                assert !isValidationFailure();
            }

            @Override
            protected void invokeApplication() {
                assert invokeMethod("#{register.register}").equals("SUCCESS");
            }
        }.run();
    }
  @Test
    public void testPwdIllegaCase() throws Exception { 
        new FacesRequest() {

            @Override
            protected void updateModelValues() {
                setValue("#{user.name}", "qwerty");
                setValue("#{user.pwd}", "654321");
                setValue("#{user.confirmPwd}", "123456");
                setValue("#{user.email}", "qwerty@123.com");
                setValue("#{user.confirmEmail}", "qwerty@123.com");
            }

            @Override
            protected void invokeApplication() {
                assert invokeMethod("#{register.register}").equals("PWD_NOT_EQ_IN_TWICE");
            }
        }.run();
    }
	......

@Test
    public void testNameExistsCase() throws Exception {
        new FacesRequest() {

            @Override
            protected void updateModelValues() {
                setValue("#{user.name}", "hypercube");
                setValue("#{user.pwd}", "654321");
                setValue("#{user.confirmPwd}", "654321");
                setValue("#{user.email}", "qwerty@124.com");
                setValue("#{user.confirmEmail}", "qwerty@124.com");
            }

            @Override
            protected void invokeApplication() {
                assert invokeMethod("#{register.register}").equals("EXISTS_NAME");
            }
        }.run();
    }

	......

}

1,因为用户注册肯定要操作数据库，所以我继承了DBUnitSeamTest，这样就可以方便的使用dbunit和hsqldb内存数据库进行测试了。
2,继承DBUnitSeamTest就要实现他的一个抽象方法protected void prepareDBUnitOperations()，主要是使用标准数据初始化数据库。RegisterDataSet.xml里面就是定义了表结构和标准数据，我的users表内容如下：

如果你被有指定其他的操作，DataSetOperation默认使用DatabaseOperation.CLEAN_INSERT作为一个构造参数。这个例子首先清空定义在BaseData.xml中所有的表然后插入所有声明在BaseData.xml中的行在@test方法每次调用之前。
3,这个方法模拟了JSF请求的生命周期包括初始化模型的值，验证模型属性的合法性(配合hibernate验证)，调用register()方法，然后通过assert验证方法是否正确的执行。
本文的讨论也很精彩，浏览讨论>>

JavaEye推荐