mybatis Generator生成代碼及使用方式

本文原創，轉載請注明：http://www.cnblogs.com/fengzheng/p/5889312.html 

為什麼要有mybatis

mybatis 是一個 Java 的 ORM 架構，ORM 的出現就是為了簡化開發。最初的開發方式是業務邏輯和資料庫查詢邏輯是分開的，或者在程式中編寫 sql 語句，或者調用 sql 存儲過程。這樣導緻思維需要在語言邏輯和 sql 邏輯之間切換，導緻開發效率低下。是以出現了一系列的 ORM 架構，ORM 架構将資料庫表和 Java 對象對應起來，當操作資料庫時，隻需要操作對象的 Java 對象即可，例如設定幾個 and 條件，隻需要設定幾個屬性即可。

為什麼要有mybatis generator

雖然說有了 mybatis 架構，但是學習 mybatis 也需要學習成本，尤其是配置它需要的 XML 檔案，那也是相當繁瑣，而且配置中出現錯誤，不容易定位。當出現莫名其妙的錯誤或者有大批量需要生成的對象時，時常會有種生無可戀的感覺在腦中徘徊。故此， mybatis generator 應運而生了。

它隻需要簡單配置，即可完成大量的表到 mybatis Java 對象的生成工作，不僅速度快，而且不會出錯，可讓開發人員真正的專注于業務邏輯的開發。

官方提供的 mybatis generator 功能比較簡單，對于稍微複雜但是開發中必然用到的分頁功能、批量插入功能等沒有實作，但已經有成熟的插件功能支援。

我已經将我們平時用的mybatis生成工具放到 github ，其中已內建了分頁、批量插入、序列化功能。可到 這裡 檢視，已經介紹了使用方法。

mybatis generator 生成的檔案結構

生成的檔案包含三類：

1. Model 實體檔案，一個資料庫表生成一個 Model 實體；
2. ModelExample 檔案，此檔案和實體檔案在同一目錄下，主要用于查詢條件構造；
3. Mapper 接口檔案，資料數操作方法都在此接口中定義；
4. Mapper XML 配置檔案；

在配置檔案中配置好檔案的生成路徑，并設定好對應的包名，即可生成對應的目錄結構和檔案。我将生成目錄設定為 test 目錄，實體包名設定為  com.fengzheng.dao.entity   ，接口包名設定為  com.fengzheng.dao.mapper ，然後生成的檔案目錄結構如下圖所示：

如何編寫代碼呢

 所有的方法調用都來自于生成的接口檔案，在 Spring MVC 中，需要在調用方聲明，用一個黑名單接口為例，生成的接口檔案為 BlackListIPMapper ，是以在調用方要聲明此接口，如下：

@Autowired
private BlackListIPMapper blackListipMapper;　　      

資料庫查詢

查詢是最常用功能，如下方法是查詢 IP 為某值的記錄，如果知道主鍵的話，可以用  selectByPrimaryKey 方法。

public BlackListIP get(String ip){
        BlackListIPExample example = new BlackListIPExample();
        example.createCriteria().andIpEqualTo(ip);
        List<BlackListIP> blackListIPList = blackListipMapper.selectByExample(example);
        if(blackListIPList!=null && blackListIPList.size()>0){
            return blackListIPList.get(0);
        }
        return null;
    }
      

更新、添加、删除方法調用方法類似，具體可檢視相關文檔介紹。　　

排序

public BlackListIP get(String ip){
        BlackListIPExample example = new BlackListIPExample();
        example.setOrderByClause("CREATE_TIME desc"); //按建立時間排序
        example.createCriteria().andIpEqualTo(ip);
        List<BlackListIP> blackListIPList = blackListipMapper.selectByExample(example);
        if(blackListIPList!=null && blackListIPList.size()>0){
            return blackListIPList.get(0);
        }
        return null;
    }
      

分頁

public PageInfo list(Account account, PageInfo pageInfo,String startTime,String endTime) {
        account.setIsDel(SysParamDetailConstant.IS_DEL_FALSE);

        AccountExample example = getCondition(account,startTime,endTime);

        if (null != pageInfo && null != pageInfo.getPageStart()) {
            example.setLimitClauseStart(pageInfo.getPageStart());
            example.setLimitClauseCount(pageInfo.getPageCount());
        }

        example.setOrderByClause(" CREATE_TIME desc ");

        List<Account> list = accountMapper.selectByExample(example);

        int totalCount = accountMapper.countByExample(example);

        pageInfo.setList(list);
        pageInfo.setTotalCount(totalCount);

        return pageInfo;
    }
      

實作 a=x and (b=xx or b=xxx)這樣的查詢條件　　

雖然自動生成代碼很友善，但凡事有利即有弊，mybatis generator 沒有辦法生成表聯查（join）功能，隻能手動添加。如下實作了a=x and (b=xx or b=xxx)這樣的條件拼接。

AccountExample accountExample = new AccountExample();
AccountExample.Criteria criteria = accountExample.createCriteria().andTypeEqualTo("4");
criteria.addCriterion(String.format(" (ID=%d or ID=%d) ",34,35));
List<Account> accounts = accountMapper.selectByExample(accountExample);
return accounts;　      

但是需要修改一點代碼，修改 org.mybatis.generator.codegen.mybatis3.model包下的ExampleGenerator的第524行代碼，将  method.setVisibility(JavaVisibility.PROTECTED);  改為  method.setVisibility(JavaVisibility.PUBLIC);  

改動已同步到github上。

天下沒有完美的輪子，用不用它，那是你的事兒。

人生沒有回頭路，珍惜當下。