mybatis入門案例自定義實現
mybatis入門案例自定義實現
1、須要實現的類和接口
public static void main(String[] args) throws Exception{
//1.讀取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.建立SqlSessionFactory工廠
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3.使用工廠生產SqlSession對象
SqlSession session = factory.openSession();
//4.使用SqlSession建立Dao的代理對象
IUserDao userDao = session.getMapper(IUserDao.class);
//5.使用代理對象執行方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//6.釋放資源
session.close();
in.close();
}
根據測試類MybatisTest中的main函數，須要實現的類有：Resources、SqlSessionFactoryBuilder，須要實現的接口有：SqlSessionFactory、SqlSession。因爲是自定義mybatis，咱們將項目配置文件pom.xml中的mybatis的相關信息刪除。html
2、依據測試類建立缺乏的接口和類
1.建立Resources類
在src/main/java目錄下，建立mybatis包，在mybatis包下建立io包，在io包下新建類Resources，添加靜態方法java
//使用類加載器讀取配置文件的類
public class Resources {
/**
* @description 根據傳入的參數獲取一個字節輸入流
* @param filePath
* @return
*/
public static InputStream getResourceAsStream(String filePath){
return Resources.class.getClassLoader().getResourceAsStream(filePath);
}
}
之因此這樣子添加，咱們能夠查看原mybatis中，getResourcesAsStream()方法的調用層級，能夠發現最終調用的就是ClassLoader類下的getResourceAsStream()方法，所以咱們直接調用該方法便可。sql
//MybatisTest.class
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//Resources.class
public static InputStream getResourceAsStream(String resource) throws IOException {
return getResourceAsStream((ClassLoader)null, resource);
}
public static InputStream getResourceAsStream(ClassLoader loader, String resource) throws IOException {
InputStream in = classLoaderWrapper.getResourceAsStream(resource, loader);
if (in == null) {
throw new IOException("Could not find resource " + resource);
} else {
return in;
}
}
//ClassLoaderWrapper.class
public InputStream getResourceAsStream(String resource, ClassLoader classLoader) {
return this.getResourceAsStream(resource, this.getClassLoaders(classLoader));
}
InputStream getResourceAsStream(String resource, ClassLoader[] classLoader) {
ClassLoader[] var3 = classLoader;
int var4 = classLoader.length;
for(int var5 = 0; var5 < var4; ++var5) {
ClassLoader cl = var3[var5];
if (null != cl) {
InputStream returnValue = cl.getResourceAsStream(resource);
if (null == returnValue) {
returnValue = cl.getResourceAsStream("/" + resource);
}
if (null != returnValue) {
return returnValue;
}
}
}
return null;
}
//ClassLoader.class
public InputStream getResourceAsStream(String name) {
Objects.requireNonNull(name);
URL url = getResource(name);
try {
return url != null ? url.openStream() : null;
} catch (IOException e) {
return null;
}
}
2.建立SqlSessionFactorty接口
在mybatis包下新建包sqlsession，在sqlsession包下新建接口SqlSessionFactorty，依據main()方法，該接口中須要聲明方法openSession()。數據庫
public interface SqlSessionFactory {
//用於打開一個新的SqlSession對象
SqlSession openSession();
}
3.建立SqlSession接口
在sqlsession包下新建接口SqlSessionFactorty，依據main()方法，該接口中須要聲明方法getMapper()和close()。數組
//自定義mybatis中和數據庫交互的核心類，能夠建立dao接口的代理對象
public interface SqlSession {
/**
* @description 根據參數建立一個代理對象
* @param daoInterfaceClass dao的接口字節碼
* @param <T>
* @return
*/
<T> T getMapper(Class<T> daoInterfaceClass);
//釋放資源
void close();
}
至於getMapper的聲明爲何是這樣子，能夠查看個人上一篇博客：mybatis入門案例分析session
4.建立SqlSessionFactoryBuilder類
在sqlsession包下建立SqlSessionFactoryBuilder類，添加一個build()方法，先返回空值，以後咱們再來補全。mybatis
/* 用於建立一個SqlSessionFactory對象 */
public class SqlSessionFactoryBuilder {
/**
* @Description: 根據字節輸入流來構建一個SqlSessionFactory工廠
* @param config
* @return
*/
public SqlSessionFactory build(InputStream config){
return null;
}
}
在原mybatis中，build()方法調用層級爲：app
//MybatisTest.class
SqlSessionFactory factory = builder.build(in);
//SqlSessionFactoryBuilder.class
public SqlSessionFactory build(InputStream inputStream) {
return this.build((InputStream)inputStream, (String)null, (Properties)null);
}
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
SqlSessionFactory var5;
try {
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
var5 = this.build(parser.parse());
} catch (Exception var14) {
throw ExceptionFactory.wrapException("Error building SqlSession.", var14);
} finally {
ErrorContext.instance().reset();
try {
inputStream.close();
} catch (IOException var13) {
}
}
return var5;
}
public SqlSessionFactory build(Configuration config) {
return new DefaultSqlSessionFactory(config);
}
能夠看到最後返回的是一個DefualtSqlSessionFactory對象，因此在自定義mybatis時，咱們也須要返回一個DefuaultSqlSessionFactory對象。並且還用到了xml文件解析類XMLConfigBuilder，所以接下來咱們須要定義xml解析類和DefuaultSqlSessionFactory類。dom
5.建立xml解析類XMLConfigBuilder
解析xml文件，咱們採用的是dom4j技術，在查找信息時，用到了XPath。因此咱們須要在項目文件pom.xml中添加上相關內容，導入jaxen是爲了可以使用XPath:ide
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.1</version>
</dependency>
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
<version>1.1.6</version>
</dependency>
在mybatis包下新建包utils，在utils包下新建類XMLConfigBuilder。解析xml不是本文重點，因此解析類的代碼在這裏直接給出：
/**
* 用於解析配置文件
*/
public class XMLConfigBuilder {
/**
* 解析主配置文件，把裏面的內容填充到DefaultSqlSession所須要的地方
* 使用的技術：dom4j+xpath
*/
public static Configuration loadConfiguration(InputStream config){
try{
//定義封裝鏈接信息的配置對象（mybatis的配置對象）
Configuration cfg = new Configuration();
//1.獲取SAXReader對象
SAXReader reader = new SAXReader();
//2.根據字節輸入流獲取Document對象
Document document = reader.read(config);
//3.獲取根節點
Element root = document.getRootElement();
//4.使用xpath中選擇指定節點的方式，獲取全部property節點
List<Element> propertyElements = root.selectNodes("//property");
//5.遍歷節點
for(Element propertyElement : propertyElements){
//判斷節點是鏈接數據庫的哪部分信息
//取出name屬性的值
String name = propertyElement.attributeValue("name");
if("driver".equals(name)){
//表示驅動
//獲取property標籤value屬性的值
String driver = propertyElement.attributeValue("value");
cfg.setDriver(driver);
}
if("url".equals(name)){
//表示鏈接字符串
//獲取property標籤value屬性的值
String url = propertyElement.attributeValue("value");
cfg.setUrl(url);
}
if("username".equals(name)){
//表示用戶名
//獲取property標籤value屬性的值
String username = propertyElement.attributeValue("value");
cfg.setUsername(username);
}
if("password".equals(name)){
//表示密碼
//獲取property標籤value屬性的值
String password = propertyElement.attributeValue("value");
cfg.setPassword(password);
}
}
//取出mappers中的全部mapper標籤，判斷他們使用了resource仍是class屬性
List<Element> mapperElements = root.selectNodes("//mappers/mapper");
//遍歷集合
for(Element mapperElement : mapperElements){
//判斷mapperElement使用的是哪一個屬性
Attribute attribute = mapperElement.attribute("resource");
if(attribute != null){
System.out.println("使用的是XML");
//表示有resource屬性，用的是XML
//取出屬性的值
String mapperPath = attribute.getValue();//獲取屬性的值"dao/IUserDao.xml"
//把映射配置文件的內容獲取出來，封裝成一個map
Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
//給configuration中的mappers賦值
cfg.setMappers(mappers);
}
}
//返回Configuration
return cfg;
}catch(Exception e){
throw new RuntimeException(e);
}finally{
try {
config.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
/**
* 根據傳入的參數，解析XML，而且封裝到Map中
* @param mapperPath 映射配置文件的位置
* @return map中包含了獲取的惟一標識（key是由dao的全限定類名和方法名組成）
* 以及執行所需的必要信息（value是一個Mapper對象，裏面存放的是執行的SQL語句和要封裝的實體類全限定類名）
*/
private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException {
InputStream in = null;
try{
//定義返回值對象
Map<String,Mapper> mappers = new HashMap<String,Mapper>();
//1.根據路徑獲取字節輸入流
in = Resources.getResourceAsStream(mapperPath);
//2.根據字節輸入流獲取Document對象
SAXReader reader = new SAXReader();
Document document = reader.read(in);
//3.獲取根節點
Element root = document.getRootElement();
//4.獲取根節點的namespace屬性取值
String namespace = root.attributeValue("namespace");//是組成map中key的部分
//5.獲取全部的select節點
List<Element> selectElements = root.selectNodes("//select");
//6.遍歷select節點集合
for(Element selectElement : selectElements){
//取出id屬性的值 組成map中key的部分
String id = selectElement.attributeValue("id");
//取出resultType屬性的值 組成map中value的部分
String resultType = selectElement.attributeValue("resultType");
//取出文本內容 組成map中value的部分
String queryString = selectElement.getText();
//建立Key
String key = namespace+"."+id;
//建立Value
Mapper mapper = new Mapper();
mapper.setQueryString(queryString);
mapper.setResultType(resultType);
//把key和value存入mappers中
mappers.put(key,mapper);
}
return mappers;
}catch(Exception e){
throw new RuntimeException(e);
}finally{
in.close();
}
}
}
6.建立配置類Configuration
解析xml文件啊返回的包含有數據庫的鏈接信息、SQL語句和查詢結果的封裝信息。在mybatis包下建立包config，在config包下新建類Configuration。結合咱們以前的入門案例分析，這個類中的屬性應該包括：driver，url，username，password，映射信息mappers。
/* 自定義mybatis的配置類 */
public class Configuration {
private String driver;
private String url;
private String username;
private String password;
private Map<String,Mapper> mappers = new HashMap<>();
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
this.mappers.putAll(mappers);
}
public String getDriver() {
return driver;
}
public void setDriver(String driver) {
this.driver = driver;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
注意：映射信息咱們是存放在一個HashMap中，這樣能夠更加方便地經過完整的id找到SQL語句和查詢結果的封裝信息。所以接下來咱們要定義一個Mapper類，而且setMapper()方法其實是一個添加新元素而且去重的方法，因此咱們不是直接賦值，而是調用putAll()方法。
7.建立Mapper類
結合咱們對入門案例的分析，咱們知道Mapper類中應該有兩大屬性，一個是queryString，即咱們要執行的SQL語句；另外一個是resultType，即封裝查詢信息的類。在config包下新建類Mapper，以下：
/*用於封裝執行的SQL語句和結果類型的全限定類名*/
public class Mapper {
private String queryString;
private String resultType;
public String getQueryString() {
return queryString;
}
public void setQueryString(String queryString) {
this.queryString = queryString;
}
public String getResultType() {
return resultType;
}
public void setResultType(String resultType) {
this.resultType = resultType;
}
}
8.建立SqlSessionFactory接口的實現類DefualtSqlSessionFactory
在mybatis包下新建包defualts，在defualts包下建立類DefualtSqlSessionFactory，openSession()方法返回的是一個操做數據庫的對象，要想操做數據庫，咱們須要提供數據庫的鏈接信息，所以須要添加Configuration類型的字段。
public class DefualtSqlSessionFactory implements SqlSessionFactory {
private Configuration cfg;
public DefualtSqlSessionFactory(Configuration cfg){
this.cfg = cfg;
}
/* 用於建立一個新的操做數據庫對象*/
@Override
public SqlSession openSession() {
return new DefualtSqlSession(cfg);
}
}
9.建立SqlSession接口的實現類DefualtSqlSession
在defualts包下建立類DefualtSqlSession。在該類中，咱們一樣須要配置信息，所以須要添加Configuration類型的字段。爲了鏈接數據庫，咱們須要添加Connection類型的字段。結合上篇文章的分析，在建立代理對象時，咱們須要指定代理方式。接下來咱們要實現的就是鏈接數據庫的類DataSourceUtil和調用selectList()方法的InvocationHandler接口的實現類。
public class DefualtSqlSession implements SqlSession {
private Configuration cfg;
private Connection connection;
public DefualtSqlSession(Configuration cfg){
this.cfg = cfg;
connection = DataSourceUtil.getConnection(cfg);
}
/* 用於建立代理對象*/
@Override
public <T> T getMapper(Class<T> daoInterfaceClass) {
return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
new Class[]{daoInterfaceClass}, new MapperProxy(cfg.getMappers(), connection));
}
/*Description: 用於釋放資源*/
@Override
public void close(){
if(connection != null){
try {
connection.close();
}catch (Exception e){
e.printStackTrace();
}
}
}
}
10.建立鏈接數據庫的類DataSourceUtil
在utils包下新建類DataSourceUtil：
/* 建立數據源的工具類 */
public class DataSourceUtil {
/* 用於獲取一個鏈接 */
public static Connection getConnection(Configuration cfg){
try {
Class.forName(cfg.getDriver());
return DriverManager.getConnection(cfg.getUrl(),cfg.getUsername(),cfg.getPassword());
}catch (Exception e){
throw new RuntimeException(e);
}
}
}
11.建立InvocationHandler接口的實現類MapperProxy
在mybatis包下新建包proxy，在proxy包下新建類MapperProxy，該類中要對數據庫進行查詢，因此須要映射信息和數據庫鏈接。在執行查詢操做時，咱們調用了Executor().selectList(mapper,conn)靜態方法，因此接下來咱們要定義工具類Executor。
public class MapperProxy implements InvocationHandler {
private Map<String, Mapper> mappers;
private Connection conn;
public MapperProxy(Map<String,Mapper> mappers, Connection conn){
this.mappers = mappers;
this.conn = conn;
}
/* 用於對方法進行加強的，其實就是調用selectList方法 */
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//1.獲取方法名
String methodName = method.getName();
//2.獲取方法所在類的名稱
String className = method.getDeclaringClass().getName();
//3.組合key
String key = className+"."+methodName;
//4.獲取mappers中的Mapper對象
Mapper mapper = mappers.get(key);
//5.判斷是否有mapper
if(mapper == null){
throw new IllegalArgumentException("傳入的參數有誤");
}
//6.調用工具類執行查詢全部
return new Executor().selectList(mapper,conn);
}
}
12.建立查詢工具類Executor
在utils包下，新建類Executor：
/* 執行查詢封裝的工具類 */
public class Executor {
public <E> List<E> selectList(Mapper mapper, Connection conn) {
PreparedStatement pstm = null;
ResultSet rs = null;
try {
//1.取出mapper中的數據
String queryString = mapper.getQueryString();//select * from user
String resultType = mapper.getResultType();//domain.User
Class domainClass = Class.forName(resultType);
//2.獲取PreparedStatement對象
pstm = conn.prepareStatement(queryString);
//3.執行SQL語句，獲取結果集
rs = pstm.executeQuery();
//4.封裝結果集
List<E> list = new ArrayList<E>();//定義返回值
while(rs.next()) {
//實例化要封裝的實體類對象
E obj = (E)domainClass.getDeclaredConstructor().newInstance();
//取出結果集的元信息：ResultSetMetaData
ResultSetMetaData rsmd = rs.getMetaData();
//取出總列數
int columnCount = rsmd.getColumnCount();
//遍歷總列數
for (int i = 1; i <= columnCount; i++) {
//獲取每列的名稱，列名的序號是從1開始的
String columnName = rsmd.getColumnName(i);
//根據獲得列名，獲取每列的值
Object columnValue = rs.getObject(columnName);
//給obj賦值：使用Java內省機制（藉助PropertyDescriptor實現屬性的封裝）
PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//要求：實體類的屬性和數據庫表的列名保持一種
//獲取它的寫入方法
Method writeMethod = pd.getWriteMethod();
//把獲取的列的值，給對象賦值
writeMethod.invoke(obj,columnValue);
}
//把賦好值的對象加入到集合中
list.add(obj);
}
return list;
} catch (Exception e) {
throw new RuntimeException(e);
} finally {
release(pstm,rs);
}
}
private void release(PreparedStatement pstm,ResultSet rs){
if(rs != null){
try {
rs.close();
}catch(Exception e){
e.printStackTrace();
}
}
if(pstm != null){
try {
pstm.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
}
13.補全SqlSessionFactoryBuilder類的build方法
build()方法是根據字節輸入流來構建一個SqlSessionFactory工廠，所以首先要對xml文件進行解析，讀取配置文件，而後返回一個DefualtSqlSessionFactory類的實例。
public SqlSessionFactory build(InputStream config){
Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
return new DefualtSqlSessionFactory(cfg);
}
3、項目結果和執行結果
到這裏，咱們就完成了自定義mybatis的經過xml文件進行配置的實現，以後咱們還能夠添加提供註解進行配置的實現，項目結構以下；
最後運行測試類的結果爲：
4、添加註解的實現
1.修改主配置文件SqlMapConfig
將mapper標籤修改成；
<mappers>
<mapper class="dao.IUserDao" />
</mappers>
2.添加註解類
在mybatis包下新建包annocations，在annocations包下新建註解Select，以下：
/* 查詢的註解 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Select {
//配置SQL語句
String value();
}
3.在dao接口中添加註解
public interface IUserDao {
@Select("select * from user")
List<User> findAll();
}
4.在xml解析類中添加對註解的解析
1.添加經過註解建立映射的函數loadMapperAnnotation()
注意在dao接口中添加註解時，咱們並無添加resultType，所以這裏咱們獲取resultType時運用了反射技術，findAll()方法的返回值是一個List，咱們只需找到這個List當中元素的類型即爲resultType。
/**
* 根據傳入的參數，獲得dao中全部被select註解標註的方法。
* 根據方法名稱和類名，以及方法上註解value屬性的值，組成Mapper的必要信息
* @param daoClassPath
* @return
*/
private static Map<String,Mapper> loadMapperAnnotation(String daoClassPath)throws Exception{
//定義返回值對象
Map<String,Mapper> mappers = new HashMap<String, Mapper>();
//1.獲得dao接口的字節碼對象
Class daoClass = Class.forName(daoClassPath);
//2.獲得dao接口中的方法數組
Method[] methods = daoClass.getMethods();
//3.遍歷Method數組
for(Method method : methods){
//取出每個方法，判斷是否有select註解
boolean isAnnotated = method.isAnnotationPresent(Select.class);
if(isAnnotated){
//建立Mapper對象
Mapper mapper = new Mapper();
//取出註解的value屬性值
Select selectAnno = method.getAnnotation(Select.class);
String queryString = selectAnno.value();
mapper.setQueryString(queryString);
//獲取當前方法的返回值，還要求必須帶有泛型信息
Type type = method.getGenericReturnType();//List<User>
//判斷type是否是參數化的類型
if(type instanceof ParameterizedType){
//強轉
ParameterizedType ptype = (ParameterizedType)type;
//獲得參數化類型中的實際類型參數
Type[] types = ptype.getActualTypeArguments();
//取出第一個
Class domainClass = (Class)types[0];
//獲取domainClass的類名
String resultType = domainClass.getName();
//給Mapper賦值
mapper.setResultType(resultType);
}
//組裝key的信息
//獲取方法的名稱
String methodName = method.getName();
String className = method.getDeclaringClass().getName();
String key = className+"."+methodName;
//給map賦值
mappers.put(key,mapper);
}
}
return mappers;
}
2.修改loadConfiguration()方法
註解和xml文件進行配置調用的方法是不同的，這裏咱們取出mapper標籤，判斷mapperElement使用的是哪一個屬性。將第二個循環體修改成：
//取出mappers中的全部mapper標籤，判斷他們使用了resource仍是class屬性
List<Element> mapperElements = root.selectNodes("//mappers/mapper");
//遍歷集合
for(Element mapperElement : mapperElements){
//判斷mapperElement使用的是哪一個屬性
Attribute attribute = mapperElement.attribute("resource");
if(attribute != null){
System.out.println("使用的是XML");
//表示有resource屬性，用的是XML
//取出屬性的值
String mapperPath = attribute.getValue();//獲取屬性的值"com/whu/cs/dao/IUserDao.xml"
//把映射配置文件的內容獲取出來，封裝成一個map
Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
//給configuration中的mappers賦值
cfg.setMappers(mappers);
}else{
System.out.println("使用的是註解");
//表示沒有resource屬性，用的是註解
//獲取class屬性的值
String daoClassPath = mapperElement.attributeValue("class");
//根據daoClassPath獲取封裝的必要信息
Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
//給configuration中的mappers賦值
cfg.setMappers(mappers);
}
}
5.運行結果
博客連接：
相關文章
- 1. 自定義SmartImageView實現（案例）
- 2. mybatis實現自定義typeHandler
- 3. Mybatis入門案例
- 4. mybatis入門案例
- 5. mybatis 入門案例
- 6. Mybatis入門實例
- 7. mybatis入門實例
- 8. Mybatis入門小案例
- 9. MyBatis 簡單入門案例
- 10. MyBatis基本入門案例
- 更多相關文章...
- • 自定義TypeHandler - MyBatis教程
- • MySQL自定義函數（CREATE FUNCTION） - MySQL教程
- • RxJava操作符（十）自定義操作符
- • YAML 入門教程
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. Duang!超快Wi-Fi來襲
- 2. 機器學習-補充03 神經網絡之**函數(Activation Function)
- 3. git上開源maven項目部署 多module maven項目（多module maven+redis+tomcat+mysql）後臺部署流程學習記錄
- 4. ecliple-tomcat部署maven項目方式之一
- 5. eclipse新導入的項目經常可以看到「XX cannot be resolved to a type」的報錯信息
- 6. Spark RDD的依賴於DAG的工作原理
- 7. VMware安裝CentOS-8教程詳解
- 8. YDOOK：Java 項目 Spring 項目導入基本四大 jar 包 導入依賴，怎樣在 IDEA 的項目結構中導入 jar 包 導入依賴
- 9. 簡單方法使得putty（windows10上）可以免密登錄樹莓派
- 10. idea怎麼用本地maven
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. 自定義SmartImageView實現（案例）
- 2. mybatis實現自定義typeHandler
- 3. Mybatis入門案例
- 4. mybatis入門案例
- 5. mybatis 入門案例
- 6. Mybatis入門實例
- 7. mybatis入門實例
- 8. Mybatis入門小案例
- 9. MyBatis 簡單入門案例
- 10. MyBatis基本入門案例