chenyangsocool
認真學習 認真生活
Intellij Idea下搭建基於Spring+SpringMvc+MyBatis的WebApi接口架構
2018-08-16 09:27 更新
強烈推薦使用Springboot來搭建MVC框架！
強烈推薦使用Springboot來搭建MVC框架！
強烈推薦使用Springboot來搭建MVC框架！
后文僅供學習參考，但是新項目強烈推薦使用Springboot來搭建MVC框架！
2018-03-06 22:42
開發工具：Intellij Idea 2017.3.4（后文統一稱為idea）
運行環境：java 9、tomcat 9（經測試在Java7+tomcat7上也可以，其它自行測試）
開發框架：Spring、SpringMvc、Mybatis（后文統一稱為SSM）
包管理工具：Maven
最終實現：WebApi接口架構、半自動MyBatis生成工具
本項目的GitHub地址：https://github.com/chenyangsocool/ssm.git
為了讓沒有接觸過idea開發工具的同學也能順利搭建，本教程盡可能詳細。如果有不明白的地方可以在留言處反饋，我會及時更新文檔。
一、創建基於Maven的SSM項目
1.打開idea，點擊Create New Project，如圖1.1:
圖1.1
2.點擊左側的Maven，勾上Create from archetype，最后在列表中選上maven-archetype-webapp選項后Next，如圖1.2：
（注意別看錯，不是cocoon-22-archetype-webapp）
圖1.2
3.設置GroupId和ArtifactId，其中GroupId可以認為是你的Java項目包結構，而ArtifactId認為是你的項目名稱，如圖1.3:
圖1.3
4.配置你的Maven目錄、Maven配置文件以及jar包存放目錄，如圖1.4：
（配置Maven過程略）
圖1.4
其中，Maven鏡像地址推薦使用阿里鏡像，setting.xml的<mirrors></mirrors>標簽內添加如下內容：
<mirror>
<id>alimaven</id>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<mirrorOf>central</mirrorOf>
</mirror>
這樣你的jar包下載速度就會炒雞快～
5.填寫項目名稱、Module名稱。這里我都使用默認。如圖1.5:
圖1.5
6.idea右下角提示處理：
6.1.Maven的包導入，如圖1.6.1:
點擊Import Changes。每次你修改了pom.xml后都會彈出該提示。
6.2.Frameworks，點擊Configure，如圖1.6.2:
會彈出提示：No Frameworks are detected。這里暫時不用理會。
7.項目的pom.xml文件如下：
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.chenyangsocool</groupId>
<artifactId>ssm</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>ssm Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
<!-- spring版本號 -->
<spring.version>4.0.2.RELEASE</spring.version>
<!-- mybatis版本號 -->
<mybatis.version>3.2.6</mybatis.version>
<!-- log4j日志文件管理包版本 -->
<slf4j.version>1.7.7</slf4j.version>
<log4j.version>1.2.16</log4j.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<!-- 表示開發的時候引入，發布的時候不會加載此包 -->
<scope>test</scope>
</dependency>
<!-- spring核心包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-oxm</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- mybatis核心包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!-- mybatis/spring包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.2.2</version>
</dependency>
<!-- 導入java ee jar 包 -->
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
</dependency>
<!-- 導入Mysql數據庫鏈接jar包 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.30</version>
</dependency>
<!-- 導入dbcp的jar包，用來在applicationContext.xml中配置數據庫 -->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.2.2</version>
</dependency>
<!-- JSTL標簽類 -->
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- 日志文件管理包 -->
<!-- log start -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<!-- 格式化對象，方便輸出日志 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.1.41</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
<!-- log end -->
<!-- 映入JSON -->
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>1.9.13</version>
</dependency>
<!-- 上傳組件包 -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.1</version>
</dependency>
<!-- mybatis-generator -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.6</version>
</dependency>
<!-- commons-io -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.6</version>
</dependency>
<!-- commons-codec -->
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.11</version>
</dependency>
<!-- commons-lang3 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.7</version>
</dependency>
</dependencies>
<build>
<finalName>ssm</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.5.1</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
8.進行Spring、SpringMvc和MyBatis的整合:
8.1.先給出我的整合后的項目結構，如圖1.8.1:
圖1.8.1
8.2.在resouces下新建jdbc.properties數據庫連接屬性文件：
driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/ssm?useUnicode=true&characterEncoding=utf-8 username=root password=root #定義初始連接數 initialSize=0 #定義最大連接數 maxActive=20 #定義最大空閑 maxIdle=20 #定義最小空閑 minIdle=1 #定義最長等待時間 maxWait=60000
8.3.在resouces下新建log4j.properties日志記錄文件：
#定義LOG輸出級別
log4j.rootLogger=INFO,Console,File
#定義日志輸出目的地為控制台
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.Target=System.out
#可以靈活地指定日志輸出格式，下面一行是指定具體的格式
log4j.appender.Console.layout = org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=[%c] - %m%n
#文件大小到達指定尺寸的時候產生一個新的文件
log4j.appender.File = org.apache.log4j.RollingFileAppender
#指定輸出目錄
log4j.appender.File.File = logs/springmvcMybatis/ssm.log
#定義文件最大大小
log4j.appender.File.MaxFileSize = 10MB
#輸出所以日志，如果換成DEBUG表示輸出DEBUG以上級別日志
log4j.appender.File.Threshold = ALL
log4j.appender.File.layout = org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern =[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c]%m%n
8.5.創建如下文件：
在main目錄下創建名為java的package，創建完成后右鍵該package》Mark Directory as 》Sources Root；
在java目錄下創建包com.chenyangsocool.ssm，再接着創建controller、dao、model、service包目錄；
在resources下創建mapping文件夾，如圖1.8.5：
圖1.8.5
8.4.在resouces下新建Spring與Mybatis整合所需的文件，spring-mybatis.xml：
<?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:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.1.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<!-- 自動掃描 -->
<context:component-scan base-package="com.chenyangsocool.ssm" />
<!-- 引入配置文件 -->
<bean id="propertyConfigurer"
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="location" value="classpath:jdbc.properties" />
</bean>
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName" value="${driver}" />
<property name="url" value="${url}" />
<property name="username" value="${username}" />
<property name="password" value="${password}" />
<!-- 初始化連接大小 -->
<property name="initialSize" value="${initialSize}"></property>
<!-- 連接池最大數量 -->
<property name="maxActive" value="${maxActive}"></property>
<!-- 連接池最大空閑 -->
<property name="maxIdle" value="${maxIdle}"></property>
<!-- 連接池最小空閑 -->
<property name="minIdle" value="${minIdle}"></property>
<!-- 獲取連接最大等待時間 -->
<property name="maxWait" value="${maxWait}"></property>
</bean>
<!-- spring和MyBatis完美整合，不需要mybatis的配置映射文件 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<!-- 自動掃描mapping.xml文件 -->
<property name="mapperLocations" value="classpath:mapping/*.xml"></property>
</bean>
<!-- DAO接口所在包名，Spring會自動查找其下的類 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.chenyangsocool.ssm.dao" />
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
</bean>
<!-- (事務管理)transaction manager, use JtaTransactionManager for global tx -->
<bean id="transactionManager"
class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource" />
</bean>
</beans>
此時，<property name="mapperLocations" value="classpath:mapping/*.xml"></property>中，*.xml是報錯的紅色狀態，別擔心，一會在里面放入xml格式的mapping文件后錯誤就會消失。
8.5.在resouces下新建spring-mvc.xml文件：
<?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:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<!--避免IE執行AJAX時，返回JSON出現下載文件 -->
<bean id="mappingJacksonHttpMessageConverter"
class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<value>text/html;charset=UTF-8</value>
</list>
</property>
</bean>
<!-- 啟動SpringMVC的注解功能，完成請求和注解model的映射 -->
<bean
class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
<property name="messageConverters">
<list>
<ref bean="mappingJacksonHttpMessageConverter" /> <!-- JSON轉換器 -->
</list>
</property>
</bean>
<!-- 對靜態資源的訪問 -->
<!-- <mvc:resources mapping="/js/**" location="/js/" />
<mvc:resources mapping="/css/**" location="/css/" /> -->
<!-- 自動掃描該包，使SpringMVC認為包下用了@controller注解的類是控制器 -->
<context:component-scan base-package="com.chenyangsocool.ssm.controller" />
<!-- 添加注解驅動 -->
<mvc:annotation-driven enable-matrix-variables="true" />
<!-- 允許對靜態資源文件的訪問 -->
<mvc:default-servlet-handler />
<!-- 定義跳轉的文件的前后綴 ，視圖模式配置 -->
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 這里的配置我的理解是自動給后面action的方法return的字符串加上前綴和后綴，變成一個 可用的url地址 -->
<property name="prefix" value="/WEB-INF/view/" />
<property name="suffix" value=".jsp" />
</bean>
<!-- 配置文件上傳，如果沒有使用文件上傳可以不用配置，當然如果不配，那么配置文件中也不必引入上傳組件包 -->
<bean id="multipartResolver"
class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 默認編碼 -->
<property name="defaultEncoding" value="UTF-8" />
<!-- 文件大小最大值 -->
<property name="maxUploadSize" value="10485760000" />
<!-- 內存中的最大值 -->
<property name="maxInMemorySize" value="40960" />
</bean>
</beans>
8.6.配置web.xml文件：
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<display-name>Archetype Created Web Application</display-name>
<!-- Spring和mybatis的配置文件 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mybatis.xml</param-value>
</context-param>
<!-- 編碼過濾器 -->
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<async-supported>true</async-supported>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- Spring監聽器 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- 防止Spring內存溢出監聽器 -->
<listener>
<listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
</listener>
<!-- Spring MVC servlet -->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<!-- 此處可以可以配置成*.do，對應struts的后綴習慣 -->
<url-pattern>/</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>/index.html</welcome-file>
<welcome-file>/index.jsp</welcome-file>
</welcome-file-list>
</web-app>
至此，基於SSM的Maven項目搭建完畢～
二、測試SSM框架
先放上該大步驟完成后的結構圖，如圖2：
圖2
1.創建數據庫：
DROP TABLE IF EXISTS `test`;
CREATE TABLE test
(
id INT PRIMARY KEY NOT NULL COMMENT 'id' AUTO_INCREMENT,
context NVARCHAR(50) NOT NULL COMMENT '內容',
view_count INT DEFAULT 0 NOT NULL COMMENT '瀏覽次數'
);
ALTER TABLE test COMMENT = '測試';
insert into `test`(`context`,`view_count`) values ('測試內容：xfjmjj',10086);
2.在view文件夾下創建test/index.jsp文件，如圖2.2:
圖2.2
3.test/index.jsp內容:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>index</title>
</head>
<body>
<h2>test's index</h2>
<br/>
${test.id}<br/>
${test.context}<br/>
${test.viewCount}
</body>
</html>
4.添加resources/mapping/TestMapper.xml：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.chenyangsocool.ssm.dao.TestDao" >
<resultMap id="BaseResultMap" type="com.chenyangsocool.ssm.model.Test" >
<id column="id" property="id" jdbcType="INTEGER" />
<result column="context" property="context" jdbcType="VARCHAR" />
<result column="view_count" property="viewCount" jdbcType="INTEGER" />
</resultMap>
<sql id="Base_Column_List" >
id, context, view_count
</sql>
<select id="getModelById" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
select
<include refid="Base_Column_List" />
from test
where id = #{id,jdbcType=INTEGER}
</select>
</mapper>
5.添加service/ITestService.java:
package com.chenyangsocool.ssm.service;
import com.chenyangsocool.ssm.model.Test;
public interface ITestService {
public Test getModelById(int id);
}
6.添加service/impl/TestServiceImpl.java:
package com.chenyangsocool.ssm.service.impl;
import com.chenyangsocool.ssm.dao.TestDao;
import com.chenyangsocool.ssm.model.Test;
import com.chenyangsocool.ssm.service.ITestService;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
@Service
public class TestServiceImpl implements ITestService {
@Resource
private TestDao testDao;
@Override
public Test getModelById(int id) {
return testDao.getModelById(id);
}
}
7.添加controller/TestController.java:
package com.chenyangsocool.ssm.controller;
import com.chenyangsocool.ssm.model.Test;
import com.chenyangsocool.ssm.service.ITestService;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
@Controller
@RequestMapping("/test")
public class TestController {
@Resource
private ITestService testService;
@RequestMapping("/index_page")
public String showIndex(HttpServletRequest request, Model model) {
int id = Integer.parseInt(request.getParameter("id"));
Test test = this.testService.getModelById(id);
//綁定對象到test/index.jsp
model.addAttribute("test", test);
return "test/index";
}
@RequestMapping("/index_api")
@ResponseBody
public Test Index(HttpServletRequest request,Model model) {
int id = Integer.parseInt(request.getParameter("id"));
return this.testService.getModelById(id);
}
}
三、配置Tomcat
（安裝Tomcat過程略）
1.工具欄中Run 》Edit Configurations 》左上角+號 》Tomcat Server 》Local，然后點擊右下角的Fix按鈕，在彈出框中選擇ssm:war exploded，如圖3.1：
圖3.1
2.在彈出的窗口中進行設置，將Name可以設置為testTomcat（不改也行），將Application context手動填入/ssm如圖3.2:
3.切換到標簽頁，按圖3.3中設置：
圖3.3
至此，基於SSM框架的WebApi接口項目搭建完成，點擊idea右上角的綠色三角形▶️運行項目：
輸入http://localhost:8080/ssm/test/index_page?id=1，可以看到網頁；
輸入http://localhost:8080/ssm/test/index_api?id=1，可以看到json接口。
四、集成Mybatis-generator
1.添加測試數據庫:
DROP TABLE IF EXISTS `user`;
CREATE TABLE user
(
id INT PRIMARY KEY NOT NULL COMMENT 'id' AUTO_INCREMENT,
context NVARCHAR(50) NOT NULL COMMENT '內容',
view_count INT DEFAULT 0 NOT NULL COMMENT '瀏覽次數'
);
ALTER TABLE user COMMENT = '測試';
insert into `user`(`context`,`view_count`) values ('測試內容：xfjmjj',10086);
2.添加com.chenyangsocool.ssm.tools.mybatis/RemarksCommentGenerator.java，該文件自定義了生成的文件的注釋，會將數據庫中的注釋轉換成實體類中的注釋：
package com.chenyangsocool.ssm.tools.mybatis;
import java.util.Date;
import org.apache.commons.lang3.time.DateFormatUtils;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.JavaElement;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.config.MergeConstants;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;
/**
* 官方類似的功能見，在版本1.3.3中添加的 addRemarkComments <br>
* http://www.mybatis.org/generator/configreference/commentGenerator.html <br>
* https://github.com/mybatis/generator/issues/23
*
* @see DefaultCommentGenerator#addRemarkComments
*/
public class RemarksCommentGenerator extends DefaultCommentGenerator {
@Override
public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
topLevelClass.addJavaDocLine("/**");
String remarks = introspectedTable.getRemarks();
if (StringUtility.stringHasValue(remarks)) {
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
for (String remarkLine : remarkLines) {
topLevelClass.addJavaDocLine(" * " + remarkLine);
}
}
topLevelClass.addJavaDocLine(" * ");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
topLevelClass.addJavaDocLine(sb.toString());
topLevelClass.addJavaDocLine(" *");
addJavadocTag(topLevelClass, false);
topLevelClass.addJavaDocLine(" */");
}
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
field.addJavaDocLine("/**");
String remarks = introspectedColumn.getRemarks();
if (StringUtility.stringHasValue(remarks)) {
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
for (String remarkLine : remarkLines) {
field.addJavaDocLine(" * " + remarkLine);
}
}
field.addJavaDocLine(" *");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
sb.append('.');
sb.append(introspectedColumn.getActualColumnName());
field.addJavaDocLine(sb.toString());
field.addJavaDocLine(" *");
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
field.addJavaDocLine("/**");
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
method.addJavaDocLine("/**");
addJavadocTag(method, false);
method.addJavaDocLine(" */");
}
public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
method.addJavaDocLine("/**");
addJavadocTag(method, false);
method.addJavaDocLine(" */");
}
protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(MergeConstants.NEW_ELEMENT_TAG);
if (markAsDoNotDelete) {
sb.append(" do_not_delete_during_merge"); //$NON-NLS-1$
}
String s = getDateString();
if (s != null) {
sb.append(' ');
sb.append(s);
}
javaElement.addJavaDocLine(sb.toString());
}
protected String getDateString() {
return DateFormatUtils.format(new Date(), "yyyy-MM-dd HH:mm:ss");
}
}
3.添加resources/generatorConfig.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
<context id="context">
<!-- 是否生成注釋 -->
<commentGenerator type="com.chenyangsocool.ssm.tools.mybatis.RemarksCommentGenerator">
</commentGenerator>
<!-- 數據庫連接 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://chenyangsocool.tpddns.cn:3306/ssm"
userId="young" password="young" />
<!-- 生成的包名和工程名 -->
<javaModelGenerator targetPackage="com.chenyangsocool.ssm.model"
targetProject="src/main/java"/>
<sqlMapGenerator targetPackage="mapping"
targetProject="src/main/resources" />
<javaClientGenerator targetPackage="com.chenyangsocool.ssm.dao"
targetProject="src/main/java" type="XMLMAPPER" />
<!-- 數據庫表 -->
<table tableName="user" domainObjectName="User">
<!-- 設置別名 -->
<!--
<columnOverride column="login_pwd" property="loginPwd" />
-->
</table>
</context>
</generatorConfiguration>
4.添加com.chenyangsocool.ssm.tools.mybatis/MyBatisGen.java:
package com.chenyangsocool.ssm.tools.mybatis;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
/**
* 使用Java運行 MyBatis Generator
*/
public class MyBatisGen {
public static void main(String[] args) throws Exception {
File file=new File("");
String abspath=file.getAbsolutePath()+"/src/main/resources/generatorConfig.xml";
File configFile = new File(abspath);
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null);
}
}
右鍵main函數，選擇“Run MyBatisGen.main()”，即可自動生成相對應的mybatis映射文件（其中實體類擁有中文注釋，很nice）
本項目的GitHub地址：https://github.com/chenyangsocool/ssm.git
參考資料：