Apache Cloudstack Development 101 -- Data Access Layer

//如果需要，使用VO接口，注意在接口中没有set方法
//如果其它代码要用到VO，应该只提供接口，而且它只是只读的对象
public interface Test {
    String getText();
    String getCreated();
}
 
 
// VO....@Entity
@Table(name="test")
public class TestVO implements Test { //假定已设定接口
    @Column(name="id")
    private long id;
 
    @Column(name="text")
    String text;
 
    @Column(name=GenericDao.CREATED_COLUMN)
    @Temporal(value=TemporalType.TIMESTAMP)
    private Date created;
 
 
 
    // 注意移除的字段没有个getter和setter方法
    // 由DAO设定和使用
    // 如果需要，可以增加getter方法，但是setter方法是没意义的
    @Column(name=GenericDao.REMOVED_COLUMN)
    @Temporal(value=TemporalType.TIMESTAMP)
    private Date removed;
 
 
    public TestVO(String text) { // 常规构造方法
        this.text = text;
    }
 
 
    protected TestVO() {  // 受保护的构造方法用于反射
    }
 
    // getter和setter方法需遵守Java约定，即将get/set放在字段前面
    public String getText() {
        return text;
    }
 
 
    public void setText(String text) {
        this.text = text;
    }
 
    // 假如你需要用到不使用标准前缀（getXXX或者isXXX）的getter方法，
    // 需在方法上标注@Column(name="<columnName>")注解
    // 来指明该方法关联的是哪一列
    @Column(name="text")
    public String retrieveText() {
        return text;
    }
 
 
    // 注意不需要创建setter方法，它有DAO代码自动创建
    public Date getCreated() {
        return created;
    }
}
 
 
// DAO... (接口不需要时可略过)
public interface TestDao extends GenericDao<TestVO, Long> {
}
 
 
// Impl...
@Local(value={HostDao.class}) // 如果已指定接口
public class TestDaoImpl extends GenericDaoBase<TestVO, Long> implements GenericDao<TestVO, Long> {
    protected TestDaoImpl() {
    }
}

public class Foo {
    @Inject TestDao _testDao;  // 注入DAO，不要new
 
    public String getText(long id) {
        TestVO vo = _testDao.findById(id);  // findById由GenericDaoBase定义
        return vo.getText();
    }
}

public class Foo {
    @Inject TestDao _testDao;
 
    public void updateText(long id, String text) {
        TestVO vo = _testDao.findById(id);
        vo.setText(text);     // 调用set方法让DAO明白修改的哪个字段
        _testDao.update(vo);
    }
}

public class Foo {
    @Inject TestDao _testDao;
    protected SearchBuilder<TestVO> TestSearch;
    public Foo() {
        // SELECT * FROM test WHERE text=? AND created<?
        // SearchBuilder的entity()实际上返回VO本身
        // 然后你就可以用使用getter方法
        TestSearch = _testDao.createSearchBuilder();
        TestVO entity = TestSearch.entity();
        TestSearch.and("bar", entity.getTest(), SearchCriteria.Op.EQ)
                  .and("time", entity.getCreated(), searchCriteria.Op.LT).done();
    }
 
    public List<? extends Test> findTest(String text, Date date) {
        SearchCriteria<TestVO> sc = TestSearch.create();
        sc.setParameters("bar", text);  // 注意“bar”是在SearchBuilder设置的参数名称
        sc.setParameters("time", date); // 注意"time"是在SearchBuilder设置的参数名称
        return _testDao.listAll(sc);
   }
}

// 生成
// SELECT * FROM HOST INNER JOIN host_tag ON host_tag.host_id=host.id WHERE host.type=? AND host.pod_id=?
// AND host.data_center_id=? AND host.cluster_id=? AND host.status=? AND resource_state=? AND host_tag.tag=?
 
SearchBuilder<HostTagVO> hostTagSearch = _hostTagsDao.createSearchBuilder();
HostTagVO tagEntity = hostTagSearch.entity();
hostTagSearch.and("tag", tagEntity.getTag(), SearchCriteria.Op.EQ);
 
SearchBuilder<HostVO> hostSearch = createSearchBuilder();
HostVO entity = hostSearch.entity();
hostSearch.and("type", entity.getType(), SearchCriteria.Op.EQ);
hostSearch.and("pod", entity.getPodId(), SearchCriteria.Op.EQ);
hostSearch.and("dc", entity.getDataCenterId(), SearchCriteria.Op.EQ);
hostSearch.and("cluster", entity.getClusterId(), SearchCriteria.Op.EQ);
hostSearch.and("status", entity.getStatus(), SearchCriteria.Op.EQ);
hostSearch.and("resourceState", entity.getResourceState(), SearchCriteria.Op.EQ);
hostSearch.join("hostTagSearch", hostTagSearch, entity.getId(), tagEntity.getHostId(), JoinBuilder.JoinType.INNER);
hostSearch.done();

// 相当于SELECT COUNT(*) FROM host WHERE data_center_id=? AND type=? AND status=?
// 在这个例子中，用GenericSearchBuilder 可以指定返回值类型(本例中是long)。
 
 
GenericSearchBuilder<HostVO, Long> CountRoutingByDc;
CountRoutingByDc = createSearchBuilder(Long.class);
CountRoutingByDc.select(null, Func.COUNT, null);
CountRoutingByDc.and("dc", CountRoutingByDc.entity().getDataCenterId(), SearchCriteria.Op.EQ);
CountRoutingByDc.and("type", CountRoutingByDc.entity().getType(), SearchCriteria.Op.EQ);
CountRoutingByDc.and("status", CountRoutingByDc.entity().getStatus(), SearchCriteria.Op.EQ);
CountRoutingByDc.done();

public class Foo {
    @Inject TestDao _testDao;
 
    @DB // 重要
    protected void updateText(long id, String text) { // 方法不能是私有的
        Transaction txn = Transaction.currentTxn(); // 获得事务上下文,但没有开始DB连接
        // ... 在此处添加代码
        txn.start();    // DB事务实际从此处开始
         TestVO vo = _testDao.lockRow(id, true);
         if (vo.getText() == null) {
            vo.setText(text);
        }
        _testDao.update(vo);
        txn.commit();   // DB 事务提交
    }
 
 
    @DB
    protected void updateTextComplicated(long id, String text) {  // 控制回滚请看这个例子.
        Transaction txn = Transaction.currentTxn();
        // ... 在此处添加代码
        boolean committed = true;
        TestVO vo = null;
        txn.start();
        try {
            vo = _testDao.lockRow(id, true);
            if (vo.getText() == null) {
                vo.setText(text);
            }
            _testDao.update(vo);
            txn.commit();
        } catch(Exception e) {
            // 记录异常日志
            committed = false;
            txn.rollback();
        }
 
 
        if (!committed) {
             // 操作没有提交
        }
    }
}