Skip to content

Latest commit

 

History

History
373 lines (312 loc) · 19.8 KB

02-DaoAndService.md

File metadata and controls

373 lines (312 loc) · 19.8 KB
Raw

⌂ Catalog
⇦ Previous section 01-Entity       ⇨ Next section 03-Logic service

02 - DAO and Service

Introduction

BaseDAO for data basic operation.
BaseService for for data basic operation package call DAO.

You must first understand the following framework

  1. Spring http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/
  2. Hibernate http://hibernate.org/
  3. Dozer https://github.com/DozerMapper/dozer
  4. MyBatis https://github.com/mybatis/mybatis-3

DAO interfaces example

package com.netsteadfast.greenstep.bsc.dao;

import java.util.List;

import com.netsteadfast.greenstep.base.dao.IBaseDAO;
import com.netsteadfast.greenstep.po.hbm.BbTest;
import com.netsteadfast.greenstep.vo.TestVO;

public interface ITestDAO<T extends java.io.Serializable, PK extends java.io.Serializable> extends IBaseDAO<BbTest, String> {

}

DAO implements example

package com.netsteadfast.greenstep.bsc.dao.impl;

import java.util.List;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Repository;

import com.netsteadfast.greenstep.base.dao.BaseDAO;
import com.netsteadfast.greenstep.bsc.dao.ITestDAO;
import com.netsteadfast.greenstep.po.hbm.BbTest;
import com.netsteadfast.greenstep.vo.TestVO;

@Repository("bsc.dao.TestDAO")
@Scope("prototype")
public class TestDAOImpl extends BaseDAO<BbTest, String> implements ITestDAO<BbTest, String> {
	
	public TestDAOImpl() {
		super();
	}
	
}

BaseDAO method description.

Name Return description
getSessionFactory() SessionFactory get hibernate session factory
getCurrentSession() Session get hibernate current session
getJdbcTemplate() JdbcTemplate get Spring JDBC template
getNamedParameterJdbcTemplate() NamedParameterJdbcTemplate get Spring JDBC template
getConnection() Connection get Spring JDBC connection
getSqlSession() SqlSession get MyBatis-3 session
updateByNativeSQL(String sql) void jdbc update
executeByNativeSQL(String sql) void jdbc execute
queryByNativeSQL(String sql, T rowMapper, Object... args) Object jdbc queryForObject
queryByNativeSQL(String sql) int jdbc query for count mode
queryForListByNativeSQL(String sql)

queryForListByNativeSQL(String sql, RowMapper rowMapper)

queryForListByNativeSQL(String sql, Object[] args)

queryForListByNativeSQL(String sql, Object[] args, RowMapper rowMapper)		 List jdbc query for List
getPersisentName() String hibernate get persisent name
count(String hql)

count(String hql, Object... args)

countByParams(Map<String, Object> params, Map<String, String> likeParams)		 int hibernate query for count mode
findList(final String hql, final int offset, final int length) List hibernate query for page grid
findPageQueryResult(String findHQL, String countHQL, Map<String, Object> params, int offset, int limit) QueryResult<> hibernate query for page grid
findPageQueryResultByQueryName(String pageQueryName, Map<String, Object> params, int offset, int limit) QueryResult<> hibernate query for page grid config from /resource/dynamichql/*-dynamic-hql.xml
save(T entityObject) T <BaseEntity> hibernate save
persist(T entityObject) T <BaseEntity> hibernate persist
update(T entityObject) T <BaseEntity> hibernate update
merge(T entityObject) T <BaseEntity> hibernate merge
delete(T entityObject) T <BaseEntity> hibernate delete
clear() void hibernate current session clear
findByPK(PK pk)

findByOid(T entityObj)

findByPK(Map<String, Object> pkMap)		 T hibernate find by OID/PK
countByPK(PK pk)

countByOid(T entityObj)

countByPK(Map<String, Object> pkMap)		 int hibernate count by OID/PK
deleteByPK(PK pk)

deleteByPK(Map<String, Object> pkMap)		 boolean hibernate delete by OID/PK
findListByParams(Map<String, Object> params, Map<String, String> likeParams, Map<String, String> orderParams)

findListByParams2(Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, String> likeParams, Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, String> likeParams, Map<String, CustomeOperational> customOperParams, Map<String, String> orderParams)		 List hibernate query list
findByUK(T entityObject)

findByEntityUK(Map<String, Object> ukMap)		 T hibernate find by UK
countByUK(T entityObject)

countByEntityUK(Map<String, Object> ukMap)		 int hibernate count by UK
getIbatisMapperNameSpace() String get MyBatis config namespace name
ibatisSelectListByParams(Map<String, Object> params) List MyBatis query list
ibatisSelectOneByValue(T valueObj) T BaseValue MyBatis query object
getDynamicHqlResource(String resource) DynamicHql get /resource/dynamichql/*-dynamic-hql.xml config
getDynamicHql(String queryName, Map<String, Object> paramMap)

getDynamicHql(String resource, String queryName, Map<String, Object> paramMap)		 String get dynamic hql from /resource/dynamichql/*-dynamic-hql.xml config


Service interfaces example

*** The service interfaces must define two static variable, MAPPER_ID_PO2VO with MAPPER_ID_VO2PO ***

package com.netsteadfast.greenstep.bsc.service;

import java.util.List;
import java.util.Map;

import com.netsteadfast.greenstep.base.exception.ServiceException;
import com.netsteadfast.greenstep.base.service.IBaseService;

public interface ITestService<T extends java.io.Serializable, E extends java.io.Serializable, PK extends java.io.Serializable> extends IBaseService<T, E, PK> {
	
	public static String MAPPER_ID_PO2VO="test.po2vo"; // Dozer mapper config PO to VO id
	public static String MAPPER_ID_VO2PO="test.vo2po"; // Dozer mapper config VO to PO id
	
}
Name description
MAPPER_ID_PO2VO value set Dozer config PO2VO id
MAPPER_ID_VO2PO value set Dozer config VO2PO id


Service implements example

*** Template T, E, PK ***

Name description
T BaseValue object
E BaseEntity object
PK PK key type default is String 
package com.netsteadfast.greenstep.bsc.service.impl;

import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import javax.annotation.Resource;

import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

import com.netsteadfast.greenstep.base.dao.IBaseDAO;
import com.netsteadfast.greenstep.bsc.dao.ITestDAO;
import com.netsteadfast.greenstep.po.hbm.BbTest;
import com.netsteadfast.greenstep.bsc.service.ITestService;
import com.netsteadfast.greenstep.vo.TestVO;

@Service("bsc.service.TestService")
@Scope("prototype")
@Transactional(propagation=Propagation.REQUIRED, readOnly=true)
public class TestServiceImpl extends BaseService<TestVO, BbTest, String> implements ITestService<TestVO, BbTest, String> {
	protected Logger logger=Logger.getLogger(TestServiceImpl.class);
	private ITestDAO<BbTest, String> testDAO;
	
	public VisionServiceImpl() {
		super();
	}

	public ITestDAO<BbTest, String> getTestDAO() {
		return testDAO;
	}

	@Autowired
	@Resource(name="bsc.dao.TestDAO")
	@Required		
	public void setTestDAO(
			ITestDAO<BbTest, String> testDAO) {
		this.testDAO = testDAO;
	}

	@Override
	protected IBaseDAO<BbTest, String> getBaseDataAccessObject() {
		return testDAO;
	}

	@Override
	public String getMapperIdPo2Vo() {		
		return MAPPER_ID_PO2VO;
	}

	@Override
	public String getMapperIdVo2Po() {
		return MAPPER_ID_VO2PO;
	}
	
}

BaseService method description.

Name Return description
getMapperIdPo2Vo() String get MAPPER_ID_PO2VO
getMapperIdVo2Po() String get MAPPER_ID_VO2PO
getBaseDataAccessObject() BaseDAO get DAO
getPlatformTransactionManager() PlatformTransactionManager get spring platform Transaction Manager
getTransactionTemplate() TransactionTemplate get spring Transaction Template
getMapper() Mapper get Dozer mapper
isSuperRole() boolean is super/Administrator user
getAccountId() String get account id
generateOid() String generate OID value
defaultString(String source) String args value null will return blank
generateDate() Date get now Date object
copyProperties(Object source, Object target) void copy source args field fill to target object
doMapper(Object sourceObject, Object targetObject, String mapperId) void copy source args field fill to target object, args mapperId is MAPPER_ID_PO2VO or MAPPER_ID_VO2PO
populate(Object bean, Map properties) void copy map field value fill to bean
fillToValueObject(Object destObject, Object origObject) void copy args origObject variable-field fill to destObject variable-field
fillToPersisentObject(Object destObject, Object origObject) void copy args origObject variable-field fill to destObject variable-field
saveIgnoreUK(T object) DefaultResult <T> Save data by value object, no to check UK / unique key on database
mergeIgnoreUK(T object) DefaultResult <T> Merge data by value object, no to check UK / unique key on database
findObjectByOid(T object) DefaultResult <T> find data by PK / primary key return value object
saveObject(T object) DefaultResult <T> Save data by value object, before will check UK / unique key on database
updateObject(T object) DefaultResult <T> Update data by value object
mergeObject(T object) DefaultResult <T> merge data by value object, before will check UK / unique key on database
deleteObject(T object) DefaultResult <Boolean> delete data by value object, success DefaultResult getValue() is true /fail is false
hibernateSessionClear() void Clear hibernate current session
save(E entityObject) <E> Save data by entity
update(E entityObject) <E> Update data by entity
merge(E entityObject) <E> merge data by entity
delete(E entityObject) <E> Delete data by entity
saveRequiresNew(E entityObject) <E> Save data by entity with @Transactional Propagation.REQUIRES_NEW mode
mergeRequiresNew(E entityObject) <E> Merge data by entity with @Transactional Propagation.REQUIRES_NEW mode
findByOid(E entityObject) <E> find data by Entity OID
countByOid(E entityObject) int count data by Entity OID
deleteByPK(String pk) boolean Delete data by PK / primary key
findByOid(E entityObject) <E> find data by Entity OID
findByPK(String pk) <E> find data by PK / primary key
countByPK(String pk) int count data by PK / primary key
deleteByPK(E entityObject) boolean delete data by entity OID
findByPK(E entityObject) <E> find data by entity OID
countByPK(E entityObject) int Count data by entity OID
deleteByPKng(PK pk) boolean delete data by PK / primary key
findByPKng(PK pk) <E> find data by PK / primary key
countByPKng(PK pk) int count data by PK / primary key
countByParams(Map<String, Object> params, Map<String, String> likeParams) long count data by parameter
countByParams(Map<String, Object> params) long count data by parameter
findListByParams(Map<String, Object> params, Map<String, String> likeParams) List<E> find data List by parameter
findListByParams(Map<String, Object> params, Map<String, String> likeParams, Map<String, String> orderParams) List<E> find data List by parameter
findListByParams(Map<String, Object> params) List<E> find data List by parameter
findListByParams2(Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, String> likeParams, Map<String, CustomeOperational> customOperParams)

findListByParams2(Map<String, Object> params, Map<String, String> likeParams, Map<String, CustomeOperational> customOperParams, Map<String, String> orderParams)		 List<E> find data List by parameter
findListVOByParams(Map<String, Object> params) List<T> find List data by parameter
findByUK(T object) DefaultResult <T> find data by value object UK / unique key
countByUK(T object) int count data by value object UK / unique key
findByEntityUK(E entityObject) <E> find data by entity object UK / unique key
countByEntityUK(E entityObject) int count data by entity object UK / unique key
ibatisSelectListByParams(Map<String, Object> params) DefaultResult<List<E>> find List by parameter on MyBatis
ibatisSelectOneByValue(E valueObj) DefaultResult<E> find by not hibernate mode entity on MyBatis
getDynamicHqlResource(String resource) DynamicHql get /resource/dynamichql/*-dynamic-hql.xml config
getDynamicHql(String queryName, Map<String, Object> paramMap)

getDynamicHql(String resource, String queryName, Map<String, Object> paramMap)		 String get dynamic hql from /resource/dynamichql/*-dynamic-hql.xml config
getQueryParamHandler(SearchValue searchValue) DynamicHqlQueryParamHandler Query page parameter handler


DynamicHqlQueryParamHandler
DynamicHqlQueryParamHandler is a handler parameter for dynamic Hql query.
Example get query parameter on BaseService object:

Map<String, Object> queryParam = super.getQueryParamHandler(searchValue)
	.fullEquals4TextField("id")
	.getValue();
Name Return description
getSourceSearchParameter() Map<String, String> return SearchValue.parameter
setSourceSearchParameter(Map<String, String> sourceSearchParameter) void set SearchValue.parameter
setSourceSearchParameterAndRoot(Map<String, String> sourceSearchParameter) void set SearchValue.parameter and init Ognl need expression variable
getRoot() Map<String, Object> get Ognl expression need parameter
getValue() Map<String, Object> get result parameter
addExprVariable(String key, Object value) DynamicHqlQueryParamHandler add Ogn expression need variable
fullEquals4TextField(String field) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
fullEquals4Select(String field) DynamicHqlQueryParamHandler if select found value, will put on result parameter
fullEquals(String field, String expression) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter.
The expression is Ognl mode
beginningLike(String field) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
beginning Like: 'TEST%'
beginningLike(String field, String expression) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
beginning Like: 'TEST%'
The expression is Ognl mode
endingLike(String field) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
ending Like: '%TEST'
endingLike(String field, String expression) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
ending Like: '%TEST'
The expression is Ognl mode
containingLike(String field) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
containing Like: '%TEST%'
containingLike(String field, String expression) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
containing Like: '%TEST%'
The expression is Ognl mode
equalsLike(String field) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
equals Like: 'TEST'
equalsLike(String field, String expression) DynamicHqlQueryParamHandler if textfield found value, will put on result parameter
equals Like: 'TEST'
The expression is Ognl mode




Config bean settings

add applicationContext-test.xml into /resource/applicationContext/bsc/standard/

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
    http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsd
    http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.1.xsd
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd">
    
    <context:annotation-config />
    
	<bean id="bsc.dao.TestDAO" class="com.netsteadfast.greenstep.bsc.dao.impl.TestDAOImpl" />
	<bean id="bsc.service.TestService" class="com.netsteadfast.greenstep.bsc.service.impl.TestServiceImpl" />
		     		
</beans>


Config add resource xml

Edit config applicationContext-BSC-STANDARD-BEANS.xml add item

<import resource="classpath*:applicationContext/bsc/standard/applicationContext-test.xml" />



Page grid query example code ( for Dynamic HQL from XML config )

reference:
Dynamic HQL XML config:
https://github.com/billchen198318/bamboobsc/blob/master/gsbsc-persistence/resource/dynamichql/BbVision-dynamic-hql.xml
Service:
https://github.com/billchen198318/bamboobsc/blob/master/gsbsc-standard/src/com/netsteadfast/greenstep/bsc/service/impl/VisionServiceImpl.java
Action:
https://github.com/billchen198318/bamboobsc/blob/master/gsbsc-web/src/com/netsteadfast/greenstep/bsc/action/VisionManagementGridQueryAction.java
View Page:
https://github.com/billchen198318/bamboobsc/blob/master/gsbsc-web/WebContent/pages/vision/vision-management.jsp

private Map<String, Object> getQueryGridParameter(SearchValue searchValue) throws Exception {
	return super.getQueryParamHandler(searchValue)
			.fullEquals4TextField("visId")
			.containingLike("title")
			.getValue();
}	

@Override
public QueryResult<List<VisionVO>> findGridResult(SearchValue searchValue, PageOf pageOf) throws ServiceException, Exception {
	if (searchValue==null || pageOf==null) {
		throw new ServiceException(SysMessageUtil.get(GreenStepSysMsgConstants.SEARCH_NO_DATA));
	}
	Map<String, Object> params=this.getQueryGridParameter(searchValue);	
	int limit=Integer.parseInt(pageOf.getShowRow());
	int offset=(Integer.parseInt(pageOf.getSelect())-1)*limit;		
	QueryResult<List<VisionVO>> result=this.visionDAO.findPageQueryResultByQueryName(
			"findVisionPageGrid", params, offset, limit);
	pageOf.setCountSize(String.valueOf(result.getRowCount()));
	pageOf.toCalculateSize();
	return result;
}