创建Spring-Mybatis web项目,解决IDEA下找不到XXXmapper.xml文件的问题
程序员文章站
2022-06-05 17:37:48
...
想着万事俱备,又不是第一次玩框架,照葫芦画瓢撑死半天就能完成了,结果我是万万没想到,全情投(填)入(坑)时间花了一天多,而且大部分是漫无目的试错,汗,发现出了问题网上找不到的时候还真是无头苍蝇。
初始的项目结构是这样的
我只是想让程序跑通,所以文件都很简单,一个domain,mapper和映射文件,spring配置文件,数据库连接配置文件,就这么简单,下面就从头讲一下如何在Intellij中创建一个这样的项目,如果有人想看解决方案,请直接移动到最底部。
- 在Intellij中new 一个Project,选择Maven项目,空的,直接next,填入Maven的
<groupId>包名</groupId>
<artifactId>项目名称</artifactId>
<version>1.0-SNAPSHOT</version>
- 1
- 2
- 3
- 这时是一个空的项目,先在pom.xml中添加需要用到的jar包依赖,我的全部依赖如下
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.gcoreinc</groupId>
<artifactId>MESService</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<!-- 添加Spring-core包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!-- 添加spring-context包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!-- 添加spring-tx包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!-- 添加spring-jdbc包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!-- 为了方便进行单元测试,添加spring-test包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!--添加spring-web包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
<!--添加aspectjweaver包 -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.5</version>
</dependency>
<!-- 添加mybatis的核心包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.2.8</version>
</dependency>
<!-- 添加mybatis与Spring整合的核心包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.2.2</version>
</dependency>
<!--Oracle -->
<!--这里有个坑,ojdbc14.jar是不会被自动下载的,需要手动下载后,找到C:\Users\{你的用户名}\.m2\repository\com\oracle\ojdbc14\10.2.0.4.0目录,将下载到的ojdbc14.jar重命名为ojdbc14-10.2.0.4.0.jar,这样就能正确通过ojdbc连接数据库了,mysql不存在此问题-->
<dependency>
<groupId>com.oracle</groupId>
<artifactId>ojdbc14</artifactId>
<version>10.2.0.4.0</version>
</dependency>
<!-- 添加junit单元测试包 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 然后创建spring的配置文件,因为spring要管理mybatis的一些配置,所以命名为spring-mybatis.xml,intellij比Eclipse智能在这里就能看出来,如果是配置文件中没有用到相关的配置项,上面的配置地址会灰色显示,和
java
类中没有用到的import
一样,而且在编辑过程中,property
的name
也会有提示,对我这种不熟悉的人非常友好
<?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:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd">
<!-- 引入dbconfig.properties属性文件 -->
<context:property-placeholder location="classpath:dbconfig.properties"/>
<!--配置数据源,这里可以换成C3P0,DBCP等等其他的链接方式-->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="${driverClassName}"/>
<property name="url" value="${jdbc_url}"/>
<property name="username" value="${jdbc_username}"/>
<property name="password" value="${jdbc_password}"/>
</bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="mapperLocations" value="classpath:com/gcoreinc/dao/*Mapper.xml"/>
<property name="typeAliasesPackage" value="com.gcoreinc.domain"/>
</bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
<property name="basePackage" value="com.gcoreinc.dao"/>
</bean>
</beans>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 配置文件写完之后,实体类无需赘述,无非是属性和
get
,set
方法,然后就是dao
接口和对应的mapper文件,BoxDetailMapper.java如下
package com.gcoreinc.dao;
import com.gcoreinc.domain.BoxDetail;
import java.util.List;
public interface BoxDetailMapper {
public List<BoxDetail> selectBoxDetailByBoxId(String boxId);
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-
mybatis
会自动根据映射文件生成实现,所以对于Mapper我们不需要写继承类,最后只要写BoxDetailMapper.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">
<!--这里的namespace必须和是对应的mapper.java的地址-->
<mapper namespace="com.gcoreinc.dao.BoxDetailMapper">
<!--这里的type,因为我在spring-mybatis.xml中配置了包的简称,所以不需要再写包名了,否则需要加上,id的话在后面的ResultMap中会用到,如果像我这样实体类的属性和数据库字段名不一致,则需要用ResultMap作为返回值,否则获取的值的字段会变成null-->
<resultMap type="BoxDetail" id="BoxDetailMap">
<result property="boxId" column="BOX_ID"/>
<result property="itemId" column="ITEM_ID"/>
<result property="itemNum" column="ITEM_NUM"/>
<result property="itemType" column="ITEM_TYPE"/>
<result property="boxType" column="BOX_TYPE"/>
<result property="userId" column="USER_ID"/>
<result property="deptid" column="DEPTID"/>
<result property="actionTime" column="ACTION_TIME"/>
<result property="eqptid" column="EQPTID"/>
<result property="dataVal1" column="DATA_VAL1"/>
<result property="dataVal2" column="DATA_VAL2"/>
<result property="dataVal3" column="DATA_VAL3"/>
<result property="dataVal4" column="DATA_VAL4"/>
<result property="dataVal5" column="DATA_VAL5"/>
<result property="dataVal6" column="DATA_VAL6"/>
<result property="dataVal7" column="DATA_VAL7"/>
<result property="dataVal8" column="DATA_VAL8"/>
</resultMap>
<!--id必须和对应的mapper.java的方法名称相同,不管返回类型是List还是只有一个,resultMap或resultType都是一样的-->
<select id="selectBoxDetailByBoxId" parameterType="String" resultMap="BoxDetailMap">
SELECT * FROM BOX_DETAIL
WHERE BOX_ID = #{boxId}
</select>
</mapper>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 至此,我感觉和大神的代码基本是相同的了,那就写个Test来测试一下呗,BoxDetailMapperTest.java,个人非常喜欢自定义注解这个功能,自己平常也都会写,Sping这种测试方法不需要手动获取Mapper映射,非常方便
package com.gcoreinc.dao;
import com.gcoreinc.domain.BoxDetail;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import java.io.IOException;
import java.util.List;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:spring-mybatis.xml"})
public class BoxDetailMapperTest {
@Autowired
private BoxDetailMapper boxDetailMapper;
@Test
public void findBoxDetailByIdTest() throws IOException {
List<BoxDetail> boxDetailList = boxDetailMapper.selectBoxDetailByBoxId("VSH130403393");
System.out.println(boxDetailList.size());
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- Ok,心情非常激动,run Test,非常预料之中的出错了
找不到selectBoxDetailByBoxId
这个方法,但是我配置文件和mapper.java的方法名称命名对应的,然后网上各种找,*上有四个这样的提问,一一看过去还是没用,于是我换一种写法,不使用BoxDetailMapper.xml
了,采用在BoxDetailMapper.java
上注解的方式执行
其他不用修改,运行test,成功。然后我debug观察到Boxdetail中的字段值都是null,说明BoxDetailMapper.xml
并没有被解析出来,于是我删除@Select
注释,把spring-mybatis.xml
中的<property name="mapperLocations" value="classpath:com/gcoreinc/dao/*Mapper.xml"/>
这句注释掉,执行test,还是报之前的错误,推断是由于spring-mybatis.xml
中无法读取Mapper.xml
配置文件造成的问题,于是开始漫长的试错之旅,最后花了半天时间,新建项目,从基础的Mybatis配置做起,再加上Spring框架,一步步尝试之后,找到了解决的方法,关键还是Intellij的问题,在编译的时候,如果配置文件不是放在Resources文件夹下就不会被执行编译,导致运行时找不到的问题。
解决方法就是在Resources文件夹下新建一个mapper文件夹,然后打开Module Setting
可以看到Intellij的文件夹有多种类型,将新建的mapper文件夹设置为Resources
,然后修改spring-mybatis.xml
文件,把MapperLoactions
修改为如下
<property name="mapperLocations" value="classpath:mapper/*Mapper.xml"/>
- 1
然后重新生成一次项目,打开target->classes->mapper
应该可以看到BoxdetailMapper.xml静静的躺在那里,而之前放在com.xxx.dao里的时候是没有被编译到target中的
最终项目目录:
运行test,完美执行。
本次填坑经历告诉我,世上本没有坑,都是自己挖出来的。