使用maven从头搭建一个Spring MVC + MyBatis项目

科技2022-07-20 94

1. 创建maven工程

2. 添加依赖

3. 添加Spring MVC框架

4. 编写一个Hello World

4.1 编写jsp文件

4.2 编写controller类

4.3 编写dispatcher-servlet.xml文件

4.4 编写wen.xml文件

4.5 添加tomcat环境

4.6 运行

5. 整合MyBatis

5.1 新建配置文件

5.2 修改web.xml文件

5.3 编写日志文件：log4j.properties

5.4 编写MyBatis配置文件

5.5 spring配置文件

6 测试

6.1 创建数据库以及关系表

6.2 创建对应的实体类

6.4 编写UserMapper.xml文件

6.5 建一个测试类

1. 创建maven工程

选择maven -> 勾选create from archetype ->选择下图的选项

填写项目名称，项目路径等信息

选择maven安装路径

完成后，项目的默认目录结构为

缺少相关目录，需要自己添加

完成目录结构如下所示：

需要注意的是，右击新建文件夹的时候，得到的文件夹可能是灰色的，需要自己将其标志成idea可认识的类型，下面以java文件为例，其他的根据实际情况进行标志。

2. 添加依赖

打开pom.xml文件，添加如下依赖

<?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>org.example</groupId> <artifactId>spring-demo</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <name>spring-demo Maven Webapp</name>  <url>http://www.example.com</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.7</maven.compiler.source> <maven.compiler.target>1.7</maven.compiler.target> <spring.version>5.2.8.RELEASE</spring.version> </properties> <dependencies>  <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency>  <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>2.0.0-alpha1</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.8.0-alpha0</version> </dependency>  <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>  <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.2</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency>  <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.4</version> </dependency>  <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.11.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.11.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.11.0</version> </dependency>  <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.5</version> </dependency>  <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>2.0.5</version> </dependency>  <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.21</version> </dependency>  <dependency> <groupId>com.mchange</groupId> <artifactId>c3p0</artifactId> <version>0.9.5.2</version> </dependency> </dependencies> <build> <finalName>spring-demo</finalName> <pluginManagement> <plugins> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> </plugin>  <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.0</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.1</version> </plugin> <plugin> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>2.8.2</version> </plugin> </plugins> </pluginManagement> </build> </project>

3. 添加Spring MVC框架

先把之前自动生成的给删了，file - > project structure

右击项目文件夹，选择Add Framework Support...

点击确定之后，在WEB-INF文件夹下面会自动生成连个文件：applicationContext.xml和dispatcher-servlet.xml，并且web.xml也生成自动添加了一些内容。

4. 编写一个Hello World

4.1 编写jsp文件

在webapp目录下，新建一个hello.jsp文件，添加如下内容：

<%@ page contentType="text/html;charset=UTF-8" language="java" %> <%@ page isELIgnored="false" %> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>Hello Spring</title> </head> <body> <h1>Hello ${requestScope.message}</h1> </body> </html>

4.2 编写controller类

在java文件夹下新建一个包：com.demo.controller，新建一个java文件：HelloSpringController，添加如下内容

package com.demo.controller; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class HelloSpringController { @RequestMapping("/hello") public String sayHello(Model model) { model.addAttribute("message", "World"); return "hello"; } }

4.3 编写dispatcher-servlet.xml文件

在webapp/WEB-INF目录下，给dispatcher-servlet.xml文件添加如下内容

4.4 编写wen.xml文件

这里需要注意：

<servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping>

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" > <web-app> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/applicationContext.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> </web-app>

4.5 添加tomcat环境

Run -> Edit Configurations

点击+号，选择Tomcat Servet -> Local

在Servet选项卡中，点击Configure添加本地的tomcat

切换Deployment选项卡，点击+号 -> Artifact

选择war deploded选项

将下面的Application context 改成 /

切回Server选项卡，可看到如下的内容，点击确定

4.6 运行

点击右上角绿色三角按钮启动tomcat

在浏览器输入http://localhost:8080/hello可得显示Hello World。

5. 整合MyBatis

5.1 新建配置文件

习惯上，我们喜欢把配置文件放到resources文件夹下，这里在resoureces文件夹下新建一个jdbc.properties文件用于存放数据库初始化数据，新建一个mybatis-config.xml用于配置MyBatis，新建一个log4j.properties用于配置输出日志。然后新建一个文件夹spring文件夹，在该文件夹下面新建三个文件：spring-dao.xml、spring-service.xml、spring-web.xml。新建一个mapper文件夹用于存放MyBatis的xml文件，最终目录结构如下：

5.2 修改web.xml文件

这里不再使用dispatcher-servlet.xml作为spring的配置文件，而是将其指定为resources下的spring文件夹中的spring-dao.xml、spring-service.xml、 spring-web.xml ：

<init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/spring-*.xml</param-value> </init-param>

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" > <web-app> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/applicationContext.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/spring-*.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> </web-app>

5.3 编写日志文件：log4j.properties

日志不是必须的，可有可无，但是喜欢上都会使用。这里使用的slf4j + log4j来输出日志，编写log4j.properties配置如下：

# 日记级别(单个级别) 文件/控制台 log4j.rootLogger=debug, stdout,file # Redirect log messages to console log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target=System.out log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p] %c{1}:%L - %m%n # Redirect log messages to a log file log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.File=/Users/xxx/Project/log/test.log log4j.appender.file.MaxFileSize=5MB log4j.appender.file.MaxBackupIndex=10 log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p] %c{1}:%L - %m%n

5.4 编写MyBatis配置文件

jdbc.properties添加如下内容：

jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/test jdbc.username=root jdbc.password=123456

mybatis-config.xml:

这里主要配置MyBatis的一些设置，根据需要，可以添加别的设置选项，我这里只添加了日志的设置

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="logImpl" value="LOG4J"/> </settings> </configuration>

5.5 spring配置文件

spring-dao.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:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">  <context:property-placeholder location="classpath:jdbc.properties" />  <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"> <property name="driverClass" value="${jdbc.driver}" /> <property name="jdbcUrl" value="${jdbc.url}" /> <property name="user" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" />  <property name="maxPoolSize" value="30" /> <property name="minPoolSize" value="10" />  <property name="autoCommitOnClose" value="false" />  <property name="checkoutTimeout" value="10000" />  <property name="acquireRetryAttempts" value="2" /> </bean>  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  <property name="dataSource" ref="dataSource" />  <property name="configLocation" value="classpath:mybatis-config.xml" />  <property name="mapperLocations" value="classpath:mapper/*.xml" /> </bean> </beans>

spring-service.xml

这里只添加了事物相关的配置

spring-web.xml

6 测试

6.1 创建数据库以及关系表

创建数据库test：

CREATE DATABASE `test`;

创建user表：

CREATE TABLE `test`.`user` ( `id` INT NOT NULL AUTO_INCREMENT, `name` VARCHAR(45) NULL, `password` VARCHAR(45) NULL, PRIMARY KEY (`id`)) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8mb4;

6.2 创建对应的实体类

创建一个com.demo.entity包，在这个包下新建一个User.java，内容如下：

package com.demo.entity; public class User { private Integer id; private String name; private String password; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } @Override public String toString() { return "User{" + "id=" + id + ", name='" + name + '\'' + ", password='" + password + '\'' + '}'; } }

6.4 编写UserMapper.xml文件

在resource文件夹下的mapper文件夹中，新建一个UserMapper.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="user"> <insert id="addUser"> INSERT INTO `user`(`name`, `password`) values(#{name}, #{password}) </insert> </mapper>

6.5 建一个测试类

在test目录下，java文件夹中新建一个包com.demo.test，并新建一个类UserMapperTest.java

package com.demo.test; import com.demo.entity.User; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.junit.Test; import org.junit.runner.RunWith; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration({"classpath:spring/spring-dao.xml", "classpath:spring/spring-service.xml"}) public class UserMapperTest { private static final Logger logger = LoggerFactory.getLogger(UserMapperTest.class); @Autowired SqlSessionFactory sqlSessionFactory; @Test public void testInsert() { SqlSession sqlSession = sqlSessionFactory.openSession(); User user = new User(); user.setName("zhangsan"); user.setPassword("123456"); int ret = sqlSession.insert("user.addUser", user); logger.debug("total insert row: {}", ret); sqlSession.close(); } }

右击testInsert -> Run 'testInsert()'

最终的项目结构：

完成。

Processed: 0.012, SQL: 8