從頭開始搭建一個mybatis+postgresql平臺

這篇將分享安裝postgresql，配置tk.mybatis的詳細步驟以及在這過程中可能遇到的一些小問題。通過少量的代碼完成大部分的工作，重覆勞動交給工具完成。 ...

最近有個項目的資料庫使用postgresql,使用原生態的mybatis操作數據，原生態的沒什麼不好，只不過國內有個tk.mybatis的工具幫助我們做了很多實用的事情，大多數情況下我們需要在原生態mybatis上加工的想法它基本上都已經有很好的實現，這篇將分享安裝postgresql，配置tk.mybatis的詳細步驟以及在這過程中可能遇到的一些小問題。

安裝postgresql，執行下麵的命令就可以安裝了：

apt-get update && apt-get install postgresql

服務端安裝好之後我們還需要一個圖形界面的客戶端pdAdmin，我安裝的是Windows版本的postgresql自帶的,可以到這個地址找對應的版本。安裝成功後預設會創建一個系統用戶，一個資料庫用戶，名稱以及密碼都是postgres,我們可以新創建用戶也可以直接使用這個帳號，反正我這隻是測試。安裝完成之後，可能會遇到遠程訪問問題：

遠程連接問題，預設情況下只允許本地連接，要想允許其它客戶端連接，我們可以修改它的配置文件，這個文件的目錄位於/etc/postgresql/9.5/main,這個目錄下有兩個文件：
1：postgresql.conf,這個是伺服器相關，裡面有一個listen_address的地址，預設只監聽本地，我們可以修改它。

2：pg_hba.cof，這個是用戶許可權相關，裡面有一個與連接相關的配置，可以配置成網關模式

成功連接之後，大概是這個樣子，我們可以創建資料庫，表等對象。

mybatis代碼生成器，資料庫與Model的映射，這類機械的工作應該交給機器來完成，詳細使用參考這裡。

通用mapper，單表的CRUD操作可以抽像出一個公共介面，tk.mybatis提供的通用mapper可以幫助我們解決這類問題。

- mapper.xml，足夠小（只包含欄位映射）

<mapper namespace="com.jim.logstashmvc.dao.generated.mapper.ProductMapper">
  <resultMap id="BaseResultMap" type="com.jim.logstashmvc.dao.generated.entity.Product">
    <!--
      WARNING - @mbggenerated
    -->
    <id column="id" jdbcType="BIGINT" property="id" />
    <result column="name" jdbcType="VARCHAR" property="name" />
  </resultMap>
</mapper>

- mapper，足夠簡單（只需要繼承通過mapper介面）

public interface ProductMapper extends Mapper<Product> {
}

插件，這裡有分頁插件，SQL性能分析插件等，與mybatis集成非常容易。

如何與spring集成?

生成器的集成，可以採用maven方式來運行代碼生成器

- 依賴的包

<!-- MyBatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>

        <!-- Spring集成 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>${mybatis.spring.version}</version>
        </dependency>

        <!-- MBG -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>${MBG.version}</version>
            <scope>compile</scope>
            <optional>true</optional>
        </dependency>

        <!-- 分頁 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>${pagehelper.version}</version>
        </dependency>

        <!-- 通用Mapper -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>${mapper.version}</version>
        </dependency>

        <!-- TkMybatis 會使用到JPA的註解 -->
        <dependency>
            <groupId>javax.persistence</groupId>
            <artifactId>persistence-api</artifactId>
            <version>1.0</version>
        </dependency>

        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>9.3-1102-jdbc41</version>
        </dependency>

- 配置生成器插件，指定配置文件路徑，配置依賴：一個是資料庫驅動，一個是通用mapper

<!--MBG-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>${MBG.version}</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.postgresql</groupId>
                        <artifactId>postgresql</artifactId>
                        <version>9.3-1102-jdbc41</version>
                    </dependency>

                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>${mapper.version}</version>
                    </dependency>

                </dependencies>
            </plugin>

生成器配置文件
- 配置資料庫連接
- 配置生成的model,mapper以及mapper.xml的存放路徑
- 配置需要生成的表信息

註意下targetRuntime，這裡採用的是MyBatis3Simple，它的預設選項是MyBatis3。如果採用通用mapper，我們在spring掃描介面時可以這樣寫。

 <bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="sqlSessionFactoryBeanName" value="jimSqlSessionFactory"/>
        <property name="basePackage" value="com.jim.logstashmvc.dao.generated.mapper"/>
    </bean>

如果是MyBatis3，生成的mapper.xml格式會複雜很多，我之前遇到過這樣的問題：使用MyBatis3生成的mapper.xml然後錯誤的配置了MapperScannerConfigurer為下麵通用mapper模式，提示我的錯誤如下，原因可以認定是配置問題（不是某個mapper.xml中的id重覆問題），後續再研究下非通用mapper的配置。

Caused by: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for com.jim.logstashmvc.dao.generated.mapper.ProductMapper.selectByExample
at org.apache.ibatis.session.Configuration$StrictMap.put(Configuration.java:837)
at org.apache.ibatis.session.Configuration$StrictMap.put(Configuration.java:809)

生成器的配置詳細如下：

<generatorConfiguration>
    <properties resource="config.properties"/>
    <context id="jim" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <plugin type="${mapper.plugin}">
            <property name="mappers" value="${mapper.Mapper}"/>
        </plugin>
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.username}"
                        password="${jdbc.password}">
        </jdbcConnection>
        <javaModelGenerator targetPackage="${targetModelPackage}"
                            targetProject="${targetJavaProject}"/>
        <sqlMapGenerator targetPackage="mapper" targetProject="${targetResourcesProject}"/>
        <javaClientGenerator targetPackage="${targetMapperPackage}"
                             targetProject="${targetJavaProject}"
                             type="XMLMAPPER">
        </javaClientGenerator>
        <table tableName="product" domainObjectName="Product"></table>
    </context>
</generatorConfiguration>

配置maven運行參數，如下圖所示即可。

mybatis的集成，主要是配置連接池信息，插件，mapper掃描等信息。

<bean id="jimDataSource" class="org.apache.commons.dbcp.BasicDataSource">
        <property name="driverClassName" value="${jdbc.driverClass}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>

        <property name="initialSize" value="5"/>
        <property name="minIdle" value="10"/>
        <property name="maxWait" value="60000"/>
        <property name="timeBetweenEvictionRunsMillis" value="60000"/>
        <property name="minEvictableIdleTimeMillis" value="3600000"/>
        <property name="validationQuery" value="SELECT 1"/>
        <property name="testWhileIdle" value="true"/>
        <property name="testOnBorrow" value="false"/>
        <property name="testOnReturn" value="false"/>
    </bean>

    <bean id="jimSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="jimDataSource"/>
        <property name="mapperLocations" value="classpath:mapper/*.xml"/>
        <property name="typeAliasesPackage" value="com.jim.logstashmvc.dao.generated.entity"/>
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageHelper">
                    <property name="properties">
                        <value>
                        dialect=postgresql
                        reasonable=true
                        supportMethodsArguments=true
                        returnPageInfo=check
                        params=count=countSql
                    </value>

                    </property>
                </bean>
            </array>
        </property>

    </bean>

    <bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="sqlSessionFactoryBeanName" value="jimSqlSessionFactory"/>
        <property name="basePackage" value="com.jim.logstashmvc.dao.generated.mapper"/>
    </bean>

通用mapper的用法：
- mapper,所有生成的mapper就繼承於Mapper<T>，預設持有通用mapper所有介面，包含CRUD常見操作
- IService，通用mapper介面的定義，我們可以根據自己的業務修改此介面

@Service
public interface IService<T> {

    T selectByKey(Object key);

    int save(T entity);

    int delete(Object key);

    int updateAll(T entity);

    int updateNotNull(T entity);

    List<T> selectByExample(Object example);

    //TODO 其他...
}

- BaseService，通用mapper的實現類

public abstract class BaseService<T> implements IService<T> {

    @Autowired
    protected Mapper<T> mapper;

    public Mapper<T> getMapper() {
        return mapper;
    }

    @Override
    public T selectByKey(Object key) {
        return mapper.selectByPrimaryKey(key);
    }

    public int save(T entity) {
        return mapper.insert(entity);
    }

    public int delete(Object key) {
        return mapper.deleteByPrimaryKey(key);
    }

    public int updateAll(T entity) {
        return mapper.updateByPrimaryKey(entity);
    }

    public int updateNotNull(T entity) {
        return mapper.updateByPrimaryKeySelective(entity);
    }

    public List<T> selectByExample(Object example) {
        return mapper.selectByExample(example);
    }

    //TODO 其他...
}

- 具體服務類

@Service
public class ProductServiceImpl extends BaseService<Product> implements ProductService {
    @Override
    public List<Product> selectByProduct(Product product, int page, int rows) {
        Example example = new Example(Product.class);
        Example.Criteria criteria = example.createCriteria();
        if(!StringUtils.isBlank(product.getName())){
            criteria.andEqualTo("name",product.getName());
        }
        if (product.getId() != null) {
            criteria.andEqualTo("id", product.getId());
        }
        PageHelper.startPage(page, rows);
        return selectByExample(example);

    }

}

安裝postgresql並且成功遠程連接，集成MBG生成mapper以及model，然後將mybatis與spring集成，最後通過通用mapper中聯起來就達到了我們的目的：通過少量的代碼完成大部分的工作，重覆勞動交給工具完成。但通用mapper有它的優點也就有它的缺點，需要根據項目環境來平衡，個人感覺利大於弊。

   本文引用：
   1：http://www.mybatis.tk/
   2：https://github.com/abel533/Mybatis-Spring