2010-11-24

Generic CRUD (Spring 3)

Time to time I have situation where generic CRUD (java, Spring) required
So - let's do it



Generic DAO here.

Main components:
- generic DAO (above)
- generic service
- generic controller
- view & generic models
and smart developer ;)

The good approach - usage jQuery & jqgrid on frontend.

jqgrid allows us to make:
- dynamic grid
- filtering
- create, update, delete, view & search by entities

URLs:
/${appName}/${entity}/management/
/${appName}/${entity}/management/index
/${appName}/${entity}/management/insert
/${appName}/${entity}/management/update
/${appName}/${entity}/management/delete


Controllers:
view plainprint?
  1. public abstract class DomainController<T extends AbstractEntity> {  
  2.   
  3.  private final Log LOG = LogFactory.getLog(getClass());  
  4.   
  5.  public abstract DomainService<T> getDomainService();  
  6.   
  7.  /** 
  8.   * Generic main page controller 
  9.   *  
  10.   * @return ModelAndView 
  11.   */  
  12.  @RequestMapping(value = "/management", method = RequestMethod.GET)  
  13.  public ModelAndView main() {  
  14.   LOG.debug("main page");  
  15.   return new ModelAndView(getMainView());  
  16.  }  
  17.   
  18.  protected abstract String getMainView();  
  19.   
  20.  /** 
  21.   * Generic entity list controller (refreshing, sorting, filtering) 
  22.   *  
  23.   * @param gridViewModel 
  24.   * @param response 
  25.   * @return ResponseGridViewModel - model in JSON for grid filling 
  26.   */  
  27.  @RequestMapping(value = "/management/index", method = RequestMethod.POST)  
  28.  @ResponseBody  
  29.  public ResponseGridViewModel<T> index(@RequestBody RequestGridViewModel gridViewModel,  
  30.    HttpServletResponse response) {  
  31.   prepareGridViewModel(gridViewModel);  
  32.   return getDomainService().getFilteredEntitiy(gridViewModel);  
  33.  }  
  34.   
  35.  /** 
  36.   * Process filtering criteria 
  37.   *  
  38.   * @param gridViewModel 
  39.   */  
  40.  protected void prepareGridViewModel(RequestGridViewModel gridViewModel) {  
  41.   if (!gridViewModel.getCriteria().isEmpty()) {  
  42.    Map<String, Object> criteriaMap = new HashMap<String, Object>();  
  43.   
  44.    for (String key : gridViewModel.getCriteria().keySet()) {  
  45.     Object value = gridViewModel.getCriteria().get(key);  
  46.     try {  
  47.      Method m = null;  
  48.   
  49.      try {  
  50.       m = getDomainService().getPersistentClass().getMethod(constructGetter(key));  
  51.      } catch (NoSuchMethodException e) {  
  52.       // it's not GET  
  53.       // let's try IS  
  54.       m = getDomainService().getPersistentClass().getMethod(constructIsGetter(key));  
  55.      }  
  56.   
  57.   
  58.      if (m.getReturnType().equals(value.getClass())) {  
  59.       criteriaMap.put(key, value);  
  60.      } else if (Integer.class.equals(m.getReturnType())) {  
  61.       criteriaMap.put(key, Integer.valueOf((String) value));  
  62.      } else if (Long.class.equals(m.getReturnType())) {  
  63.       criteriaMap.put(key, Long.valueOf((String) value));  
  64.      } else if (Boolean.class.equals(m.getReturnType())) {  
  65.       criteriaMap.put(key, Boolean.valueOf((String) value));  
  66.      }  
  67.   
  68.     } catch (Exception e) {  
  69.      // skip method - out of the scope  
  70.     }  
  71.    }  
  72.   
  73.    gridViewModel.setCriteria(criteriaMap);  
  74.   }  
  75.  }  
  76.   
  77.  private String constructGetter(String strKey) {  
  78.   return "get" + WordUtils.capitalize(strKey);  
  79.  }  
  80.   
  81.  private String constructIsGetter(String strKey) {  
  82.   return "is" + WordUtils.capitalize(strKey);  
  83.  }  
  84.   
  85.  /** 
  86.   * Insert generic controller 
  87.   *  
  88.   * @param entity 
  89.   * @param response 
  90.   * @throws IOException 
  91.   */  
  92.  @RequestMapping(value = "/management/insert", method = RequestMethod.POST)  
  93.  protected void doInsert(@RequestBody T entity, HttpServletResponse response) throws IOException {  
  94.   
  95.   entity.setId(null);  
  96.   LOG.debug("add entity : " + entity);  
  97.   
  98.   // validation entity  
  99.   Map<String, String> failures = validateOnInsert(entity);  
  100.   if (!failures.isEmpty()) {  
  101.    response.getWriter().write(validationMessages(failures));  
  102.   } else {  
  103.    getDomainService().insert(entity);  
  104.   }  
  105.  }  
  106.   
  107.  /** 
  108.   * Update generic controller 
  109.   *  
  110.   * @param entity 
  111.   * @param response 
  112.   * @throws IOException 
  113.   */  
  114.  @RequestMapping(value = "/management/update", method = RequestMethod.POST)  
  115.  protected void doUpdate(@RequestBody T entity, HttpServletResponse response) throws IOException {  
  116.   LOG.debug("update entity : " + entity);  
  117.   
  118.   // validation entity  
  119.   Map<String, String> failures = validateOnUpdate(entity);  
  120.   if (!failures.isEmpty()) {  
  121.    response.getWriter().write(validationMessages(failures));  
  122.   } else {  
  123.    getDomainService().update(entity);  
  124.   }  
  125.  }  
  126.   
  127.  /** 
  128.   * Delete generic controller 
  129.   *  
  130.   * @param entityId 
  131.   * @param response 
  132.   */  
  133.  @RequestMapping(value = "/management/delete", method = RequestMethod.POST)  
  134.  public void doDelete(@RequestParam("id") long entityId, HttpServletResponse response) {  
  135.   LOG.debug("remove item ID : " + entityId);  
  136.   getDomainService().removeEntity(entityId);  
  137.  }  
  138.   
  139.  protected String validationMessages(Map<String, String> failures) {  
  140.   StringBuffer sb = new StringBuffer();  
  141.   
  142.   for (String failureMsg : failures.values()) {  
  143.    if (sb.length() > 0) {  
  144.     sb.append("\",");  
  145.    }  
  146.    sb.append("\"").append(failureMsg).append("\"");  
  147.   }  
  148.   
  149.   if (failures.size() > 0) {  
  150.    sb.insert(0, "{\"error\":[");  
  151.    sb.append("]}");  
  152.   }  
  153.   
  154.   return sb.toString();  
  155.  }  
  156.   
  157.  /** 
  158.   * Generic entity validation on insert - could be overridden 
  159.   *  
  160.   * @param entity 
  161.   * @return 
  162.   */  
  163.  protected Map<String, String> validateOnInsert(T entity) {  
  164.   return new HashMap<String, String>();  
  165.  }  
  166.   
  167.  /** 
  168.   * Generic entity validation on update - could be overridden 
  169.   *  
  170.   * @param entity 
  171.   * @return 
  172.   */  
  173.  protected Map<String, String> validateOnUpdate(T entity) {  
  174.   return new HashMap<String, String>();  
  175.  }  
  176.   
  177. }  


view plainprint?
  1. @Controller(value = "concreteDomainController")  
  2. @RequestMapping("/entity")  
  3. public class ConcreteDomainController extends DomainController<Entity> {  
  4.   
  5.  private String view = "entityIndex";  
  6.    
  7.  private ConcreteDomainService domainService;  
  8.   
  9.  public void setConcreteDomainService(ConcreteDomainService domainService) {  
  10.   this.domainService = domainService;  
  11.  }  
  12.   
  13.  @Override  
  14.  public DomainService<Entity> getDomainService() {  
  15.   return domainService;  
  16.  }  
  17.   
  18.  @Override  
  19.  protected String getMainView() {  
  20.   return view;  
  21.  }  
  22.   
  23.  public void setView(String view) {  
  24.   this.view = view;  
  25.  }  
  26.   
  27. }  


Models:
view plainprint?
  1. public class RequestGridViewModel implements Serializable {  
  2.   
  3.  private static final long serialVersionUID = 997675961840479859L;  
  4.   
  5.  private Map<String, Object> criteria;  
  6.   
  7.  private Boolean search = Boolean.FALSE;  
  8.   
  9.  private Integer page = 0;  
  10.   
  11.  private Integer rows = 0;  
  12.   
  13.  private String order;  
  14.   
  15.  private String sort;  
  16.   
  17.  public RequestGridViewModel() {  
  18.   criteria = new HashMap<String, Object>();  
  19.  }  
  20.   
  21.  public Integer getPage() {  
  22.   return page;  
  23.  }  
  24.   
  25.  public void setPage(Integer page) {  
  26.   this.page = page;  
  27.  }  
  28.   
  29.  public Integer getRows() {  
  30.   return rows;  
  31.  }  
  32.   
  33.  public void setRows(Integer rows) {  
  34.   this.rows = rows;  
  35.  }  
  36.   
  37.  public Boolean getSearch() {  
  38.   return search;  
  39.  }  
  40.   
  41.  public void setSearch(Boolean search) {  
  42.   this.search = search;  
  43.  }  
  44.   
  45.  public String getOrder() {  
  46.   return order;  
  47.  }  
  48.   
  49.  public void setOrder(String order) {  
  50.   this.order = order;  
  51.  }  
  52.   
  53.  public String getSort() {  
  54.   return sort;  
  55.  }  
  56.   
  57.  public void setSort(String sort) {  
  58.   this.sort = sort;  
  59.  }  
  60.   
  61.  public Map<String, Object> getCriteria() {  
  62.   return criteria;  
  63.  }  
  64.   
  65.  public void setCriteria(Map<String, Object> criteria) {  
  66.   this.criteria = criteria;  
  67.  }  
  68.   
  69.  @Override  
  70.  public String toString() {  
  71.   return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);  
  72.  }  
  73.   
  74.  @Override  
  75.  public int hashCode() {  
  76.   return HashCodeBuilder.reflectionHashCode(this);  
  77.  }  
  78.   
  79.  @Override  
  80.  public boolean equals(Object obj) {  
  81.   return EqualsBuilder.reflectionEquals(this, obj);  
  82.  }  
  83.   
  84. }  


view plainprint?
  1. public class ResponseGridViewModel<T> implements Serializable {  
  2.   
  3.  private static final long serialVersionUID = -2277041672814148333L;  
  4.   
  5.  private List<T> gridData;  
  6.   
  7.  private int currPage;  
  8.   
  9.  private int totalPages;  
  10.   
  11.  private int totalRecords;  
  12.   
  13.  public ResponseGridViewModel() {  
  14.  }  
  15.   
  16.  public ResponseGridViewModel(List<T> gridData, int currPage, int totalPages, int totalRecords) {  
  17.   this.gridData = gridData;  
  18.   this.currPage = currPage;  
  19.   this.totalPages = totalPages;  
  20.   this.totalRecords = totalRecords;  
  21.  }  
  22.   
  23.  public List<T> getGridData() {  
  24.   return gridData;  
  25.  }  
  26.   
  27.  public void setGridData(List<T> gridData) {  
  28.   this.gridData = gridData;  
  29.  }  
  30.   
  31.  public int getCurrPage() {  
  32.   return currPage;  
  33.  }  
  34.   
  35.  public void setCurrPage(int currPage) {  
  36.   this.currPage = currPage;  
  37.  }  
  38.   
  39.  public int getTotalPages() {  
  40.   return totalPages;  
  41.  }  
  42.   
  43.  public void setTotalPages(int totalPages) {  
  44.   this.totalPages = totalPages;  
  45.  }  
  46.   
  47.  public int getTotalRecords() {  
  48.   return totalRecords;  
  49.  }  
  50.   
  51.  public void setTotalRecords(int totalRecords) {  
  52.   this.totalRecords = totalRecords;  
  53.  }  
  54.   
  55.  @Override  
  56.  public String toString() {  
  57.   return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);  
  58.  }  
  59.   
  60.  @Override  
  61.  public int hashCode() {  
  62.   return HashCodeBuilder.reflectionHashCode(this);  
  63.  }  
  64.   
  65.  @Override  
  66.  public boolean equals(Object obj) {  
  67.   return EqualsBuilder.reflectionEquals(this, obj);  
  68.  }  
  69.   
  70. }  


View:
view plainprint?
  1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>  
  2.   
  3. <html>  
  4.  <head>  
  5.   <link rel="stylesheet" type="text/css" href="${pageContext.request.contextPath}/css/redmond/jquery-ui-1.8.6.custom.css" />  
  6.   <link rel="stylesheet" type="text/css" href="${pageContext.request.contextPath}/css/ui.jqgrid.css" />  
  7.   <link rel="stylesheet" type="text/css" href="${pageContext.request.contextPath}/css/main.css" />  
  8.     
  9.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery-1.4.2.min.js" ></script>  
  10.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery.json-2.2.min.js" ></script>  
  11.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery-ui-1.8.6.custom.min.js" ></script>  
  12.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/i18n/grid.locale-en.js" ></script>  
  13.     
  14.   <script type="text/javascript">  
  15.    jQuery.jgrid.no_legacy_api = true;  
  16.   </script>  
  17.     
  18.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery.jqGrid.min.js" ></script>  
  19.   <script type="text/javascript" src="${pageContext.request.contextPath}/js/entityProcessor.js" ></script>  
  20.  </head>  
  21.  <body>   
  22.   <table id="gridContainer"></table>  
  23.   <div id="pagerGridContainer"></div>   
  24.  </body>  
  25. </html>  


entityProcessor.js :
view plainprint?
  1. if (typeof (DomainProcessor) == 'undefined') {  
  2.  var DomainProcessor = {  
  3.   columns : [],  
  4.   processInsertResponse : function(response, postdata) {  
  5.    var success = true;  
  6.    var msg = "";  
  7.    if(response.responseText != "") {  
  8.     var obj = jQuery.parseJSON(response.responseText);  
  9.     if(obj != null && obj.error !== 'undefined') {  
  10.      success = false;  
  11.        
  12.      msg = "<ul>";  
  13.      $.each(obj.error, function(index, value) {  
  14.       msg += "<li>" + value + "</li>";  
  15.      });  
  16.      msg += "</ul>";  
  17.     }  
  18.    }  
  19.    return [success, msg, null];     
  20.   },  
  21.   processUpdateResponse : function(response, postdata) {  
  22.    DomainProcessor.processInsertResponse(response, postdata);  
  23.   },  
  24.   init : function() {  
  25.    jQuery("#gridContainer").jqGrid({  
  26.     ajaxGridOptions : {  
  27.      type : 'POST',  
  28.      contentType : 'application/json',  
  29.     },  
  30.     serializeGridData : function(postdata) {  
  31.      if(postdata.search == true) {  
  32.       if(DomainProcessor.columns.length == 0) {  
  33.        var colModel = jQuery("#gridContainer").jqGrid('getGridParam','colModel');  
  34.        $.each(colModel, function(i, item) {  
  35.         DomainProcessor.columns.push(item.name);  
  36.        });  
  37.       }  
  38.         
  39.       var transformedPostData = {};  
  40.       var objectJson = new Object;  
  41.         
  42.       $.each(postdata, function(i, item) {  
  43.        if(-1 != jQuery.inArray(i, DomainProcessor.columns)) {  
  44.         if(objectJson['criteria'] == undefined) {  
  45.          objectJson['criteria'] = {};  
  46.         }  
  47.         objectJson['criteria'][i] = item;  
  48.        } else {  
  49.         objectJson[i] = item;  
  50.        }  
  51.       });  
  52.         
  53.       postdata = objectJson;  
  54.      }  
  55.      return $.toJSON(postdata);  
  56.     },  
  57.     url : 'index',  
  58.     editurl : 'manipulation',  
  59.     jsonReader: {  
  60.      root : 'gridData',  
  61.      page : 'currPage',  
  62.      total : 'totalPages',  
  63.      records : 'totalRecords',  
  64.      repeatitems : false,  
  65.     },  
  66.     datatype : 'json',  
  67.     colNames : [ '#', 'Name', 'Active' ],  
  68.     colModel : [ {  
  69.      name : 'id',  
  70.      index : 'id',  
  71.      width : 20,  
  72.      key : true,  
  73.      sortable: true,  
  74.      editable: false,  
  75.      search: true  
  76.     }, {  
  77.      name : 'name',  
  78.      index : 'name',  
  79.      sortable : true,  
  80.      editable : true,  
  81.      edittype : 'text',  
  82.      editoptions : {size:10, maxlength: 10},  
  83.      editrules : {required:true},  
  84.      search: true  
  85.     }, {  
  86.      name : 'active',  
  87.      index : 'active',  
  88.      width : 80,  
  89.      editable : true,  
  90.      edittype : 'checkbox',  
  91.      editoptions : {value:"true:false"},  
  92.      search:true,  
  93.      sortable : false,  
  94.     } ],  
  95.     rowNum : 10,  
  96.     width : 700,  
  97.     height : 300,  
  98.     rowList : [ 2, 5, 10 ],  
  99.     pager : '#pagerGridContainer',  
  100.     viewrecords : true,  
  101.     caption : "Entity domain edit",  
  102.     prmNames : {  
  103.      search : "search",  
  104.      order : "order",  
  105.      oper : "action",  
  106.      sort : "sort"  
  107.     }  
  108.    }).jqGrid('filterToolbar', { searchOnEnter: true });  
  109.   
  110.    jQuery("#gridContainer").jqGrid('navGrid',  
  111.      '#pagerGridContainer', {  
  112.       edit : true,  
  113.       add : true,  
  114.       view : true,  
  115.       del : true,  
  116.       search : false  
  117.      },  
  118.      // prmEdit, prmAdd, prmDel, prmSearch, prmView  
  119.            {  
  120.       closeAfterAdd: true,  
  121.       closeAfterEdit: true,  
  122.       viewPagerButtons: false,  
  123.       top: 100,  
  124.       left: 100,        
  125.       url:'update',  
  126.       afterSubmit : DomainProcessor.processInsertResponse,  
  127.       ajaxEditOptions : {  
  128.        type : 'POST',  
  129.        contentType : 'application/json',  
  130.       },  
  131.       serializeEditData: function(data) {  
  132.        return $.toJSON($.extend({}, data));  
  133.       }  
  134.      },  
  135.            {  
  136.       closeAfterAdd: true,  
  137.       closeAfterEdit: true,  
  138.       viewPagerButtons: false,  
  139.       afterSubmit : DomainProcessor.processInsertResponse,  
  140.       top: 100,  
  141.       left: 100,  
  142.       url:'insert',  
  143.       ajaxEditOptions : {  
  144.        type : 'POST',  
  145.        contentType : 'application/json',  
  146.       },  
  147.       serializeEditData: function(data) {  
  148.        return $.toJSON($.extend({}, data, {id:0}));  
  149.       }  
  150.      },  
  151.            {url:'delete'},  
  152.            {},  
  153.            {viewPagerButtons: false}  // view  
  154.      );  
  155.   }  
  156.  };  
  157. }  
  158.   
  159. jQuery(document).ready(function() {  
  160.  DomainProcessor.init();  
  161. });  


Service:
view plainprint?
  1. public interface DomainService<T extends AbstractEntity> {  
  2.   
  3.  ResponseGridViewModel<T> getFilteredEntitiy(RequestGridViewModel gridViewModel);  
  4.   
  5.  void removeEntity(Long entityId);  
  6.   
  7.  void insert(T entity);  
  8.   
  9.  void update(T entity);  
  10.   
  11.  Class<T> getPersistentClass();  
  12.   
  13. }  


view plainprint?
  1. public class DomainServiceImpl<T extends AbstractEntity> implements DomainService<T> {  
  2.   
  3.  private final Log LOG = LogFactory.getLog(getClass());  
  4.   
  5.  private Class<T> persistentClass;  
  6.   
  7.  private GenericRepository<T> rep;  
  8.   
  9.  public void setGenericRepository(GenericRepository<T> rep) {  
  10.   this.rep = rep;  
  11.  }  
  12.   
  13.  @Override  
  14.  public Class<T> getPersistentClass() {  
  15.   return persistentClass;  
  16.  }  
  17.   
  18.  @SuppressWarnings("unchecked")  
  19.  public DomainServiceImpl() {  
  20.   this.persistentClass = (Class<T>) ((ParameterizedType) getClass().getGenericSuperclass())  
  21.     .getActualTypeArguments()[0];  
  22.  }  
  23.   
  24.  @Override  
  25.  public ResponseGridViewModel<T> getFilteredEntitiy(RequestGridViewModel gridViewModel) {  
  26.   ResponseGridViewModel<T> gridResponse = new ResponseGridViewModel<T>();  
  27.   
  28.   Map<String, Object> crits = new HashMap<String, Object>();  
  29.   
  30.   int maxResults = gridViewModel.getRows();  
  31.   int firstResult = ((gridViewModel.getPage() - 1) * maxResults);  
  32.   
  33.   // criterias  
  34.   if (gridViewModel.getSearch() && !gridViewModel.getCriteria().isEmpty()) {  
  35.    crits.putAll(gridViewModel.getCriteria());  
  36.   }  
  37.     
  38.   if(!gridViewModel.getCriteria().containsKey("active")) {  
  39.    crits.put("active", Boolean.TRUE);  
  40.   }  
  41.   
  42.   // ordering  
  43.   String orderByField = (StringUtils.isEmpty(gridViewModel.getSort())) ? "id" : gridViewModel.getSort();  
  44.   OrderBy orderBy = ("desc".equals(gridViewModel.getOrder())) ? OrderBy.desc(orderByField) : OrderBy.asc(orderByField);  
  45.   
  46.   List<T> entities = rep.findByCriteria(getPersistentClass(), crits, firstResult, maxResults, orderBy);  
  47.   gridResponse.setGridData(entities);  
  48.   
  49.   // page counting  
  50.   Integer totalRecords = rep.findByCriteria(getPersistentClass(), crits);  
  51.   
  52.   int totalPages = (totalRecords / maxResults) + (((totalRecords % maxResults) == 0) ? 0 : 1);  
  53.   gridResponse.setTotalPages(totalPages);  
  54.   gridResponse.setTotalRecords(totalRecords);  
  55.   
  56.   int currentPage = gridViewModel.getPage();  
  57.   
  58.   if (currentPage > totalPages) {  
  59.    currentPage = 1;  
  60.   }  
  61.     
  62.   if (totalPages == 1) {  
  63.    currentPage = 1;  
  64.   }  
  65.   
  66.   if (totalPages == 0) {  
  67.    currentPage = 0;  
  68.   }  
  69.   
  70.   gridResponse.setCurrPage(currentPage);  
  71.   
  72.   return gridResponse;  
  73.  }  
  74.   
  75.  @Override  
  76.  public void removeEntity(Long entityId) {  
  77.   LOG.debug("remove entity ID : " + entityId);  
  78.   
  79.   T entity = rep.findById(getPersistentClass(), entityId);  
  80.   
  81.   if (entity != null) {  
  82.    rep.remove(entity);  
  83.   }  
  84.  }  
  85.   
  86.  @Override  
  87.  public void insert(T entity) {  
  88.   rep.add(entity);  
  89.  }  
  90.   
  91.  @Override  
  92.  public void update(T entity) {  
  93.   rep.update(entity);  
  94.  }  
  95.   
  96. }  


view plainprint?
  1. public interface EntityDomainService extends DomainService<Entity> {  
  2.   
  3. }  


view plainprint?
  1. @Service  
  2. public class EntityDomainServiceImpl extends DomainServiceImpl<Entity> implements EntityDomainService {  
  3.   
  4. }  


I hope - this story helps you :)
at
Labels: , , , ,

1 comment:

Gustavo said...

Thanks for share your code with us.

Could you send or post your code (this app example)?

March 14, 2013 at 5:03 AM

Post a Comment

Subscribe to: Post Comments (Atom)