一、搭建目的
唠叨几句,搭建环境是一个非常重要但是又不经常做的一个工作,平时也就在原有项目上进行修修补补,如果要开发一个干净全新的项目,拿旧项目做裁剪又很麻烦,稍有不慎各种报错,真的是一言难尽啊。虽然开发很熟练,但是要从零开始快速搭建一个项目,还是有不少的挑战(勿喷),介于后期参考方便,因此做一个目录来记录搭建步骤,先且为己!
二、环境及版本要求
考虑到所用框架 对 jdk1.8 和 jdk17 这两个版本的支持较稳定,因此结合在版本方面做了区分,在搭建过程中也就是pom配置上有部分区分,示例代码基本一致,不同之处也会在文中说明。
| 序号 | 环境名称 | JDK_1.8 | JDK_17 |
|---|---|---|---|
| 1 | 操作系统 | deppin 社区版(20.9) | deppin 社区版(20.9) |
| 2 | IntelliJ IDEA | 2023.2 (Ultimate Edition) | 2023.2 (Ultimate Edition) |
| 3 | JDK | 1.8.0_201 | 17.0.14 |
| 4 | Maven | 3.5.0 | 3.9.9 |
| 5 | Tomcat | 8.5.31 | 11.0.5 |
| 6 | javaee-api | 7.0 | 11.0.0 |
| 7 | spring | 5.3.22 | 6.2.6 |
| 8 | spring-data-bom | 2021.2.1 | 2024.0.1 |
| 9 | hibernate-core | 5.6.15.Final | 7.0.0.Alpha1 |
| 10 | mybatis-spring | 2.1.2 | 3.0.4 |
| 11 | mybatis | 3.5.19 | 3.5.19 |
| 12 | freemarker | 2.3.34 | 2.3.34 |
三、搭建项目
1、创建项目
1.1、创建项目所需模块
在IDEA中创建一个maven项目,具体模块如下图(图3-1)所示,码友们如觉得模块太多可自行裁剪合并。
1.2、配置根 pom
在项目根 pom 中配置全局版本号参数,如下图(图3-2)所示:
<!-- jdk1.8+ start -->
<spring-version>5.3.22</spring-version>
<mybatis-spring-version>2.1.2</mybatis-spring-version>
<spring-data-version>2021.2.1</spring-data-version>
<hibernate-core-version>5.6.15.Final</hibernate-core-version>
<!-- jdk1.8+ end -->
<!-- jdk17+ start -->
<spring-version>6.2.6</spring-version>
<mybatis-spring-version>3.0.4</mybatis-spring-version>
<spring-data-version>2024.0.1</spring-data-version>
<hibernate-core-version>7.0.0.Alpha1</hibernate-core-version>
<!-- jdk17+ end -->
1.3、配置 common 模块pom
<dependencies>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.19.0</version>
</dependency>
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>2.0.57</version>
</dependency>
<!-- JDK_1.8 start -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.24.1</version>
</dependency>
<!-- JDK_1.8 end -->
<!-- JDK_17 start -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>3.0.0-beta2</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-fileupload2-jakarta</artifactId>
<version>2.0.0-M1</version>
</dependency>
<dependency>
<groupId>org.eclipse</groupId>
<artifactId>yasson</artifactId>
<version>3.0.4</version>
</dependency>
<!-- JDK_17 end -->
</dependencies>
1.4、配置 model 模块pom
<dependencies>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-common</artifactId>
<version>${project-version}</version>
</dependency>
<!-- JDK_1.8 start -->
<dependency><!-- 持久化 -->
<groupId>javax.persistence</groupId>
<artifactId>javax.persistence-api</artifactId>
<version>2.2</version>
</dependency>
<!-- JDK_1.8 end -->
<!-- JDK_17 start -->
<dependency><!-- 持久化 -->
<groupId>jakarta.persistence</groupId>
<artifactId>jakarta.persistence-api</artifactId>
<version>3.2.0</version>
</dependency>
<!-- JDK_17 end -->
</dependencies>
1.5、配置 dao 模块pom
<dependencyManagement>
<dependencies>
<dependency><!-- 用于自动管理 jpa 版本 -->
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-bom</artifactId>
<version>${spring-data-version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-common</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-model</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
</dependency>
<!-- jpa hibernate start -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<version>${hibernate-core-version}</version>
</dependency>
<!-- jpa hibernate end -->
<!-- mybatis start -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis-version}</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>${mybatis-spring-version}</version>
</dependency>
<!-- mybatis end -->
<!-- postgresql start -->
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>${postgresql-version}</version>
</dependency>
<!-- postgresql end -->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
</dependencies>
1.6、配置 service 模块pom
<dependencies>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-common</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-model</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-dao</artifactId>
<version>${project-version}</version>
</dependency>
</dependencies>
1.7、配置 web 模块pom
此处需要注意 javaee 的引用,javaee9及以上将 javax 全部替换 jakarta 版本
<dependencies>
<!-- JDK_1.8 start -->
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
<scope>provided</scope><!-- 在服务器运行时由容器提供 -->
</dependency>
<!-- JDK_1.8 end -->
<!-- JDK_17 start -->
<dependency>
<groupId>jakarta.platform</groupId>
<artifactId>jakarta.jakartaee-web-api</artifactId>
<version>11.0.0</version> <!-- 注意检查最新版本 -->
<scope>provided</scope> <!-- 在服务器运行时由容器提供 -->
</dependency>
<!-- JDK_17 end -->
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-common</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-model</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-dao</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>${project-groupId}</groupId>
<artifactId>${project-artifactId}-service</artifactId>
<version>${project-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</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-aop</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</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-web</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>${freemarker-version}</version>
</dependency>
</dependencies>
2、搭建 web 模块
2.1、目录结构

2.2、配置 web.xml
加载 spring 上下文监听、配置字符编码过滤器、配置前台控制器DispatcherServlet
<?xml version="1.0" encoding="UTF-8" ?>
<web-app id="web_admin_id" version="3.0"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://www.sum.com/xml/ns/javaee/web-app_3_0.xsd">
<context-param><!-- 此参数主要给ApplicationContext使用 -->
<param-name>contextConfigLocation</param-name>
<param-value>classpath:application-config.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<filter>
<filter-name>characterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>webServelt</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring/dispatcher-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>webServelt</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
</web-app>
2.3、上下文监听配置
application-config.xml 对应 web.xml 文中 contextConfigLocation 参数值,具体配置如下:
<?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
http://www.springframework.org/schema/context/spring-context.xsd">
<!--在使用 <context:component-scan> 时,
通常不需要包括 <context:annotation-config> 元素。-->
<!--扫描该包下所有类,在启动时为注解类创建实例并放进ioc容器中-->
<context:component-scan base-package="org.example"/>
<!--引入其他spring配置文件, 例如定时器等-->
<import resource="classpath:spring/spring-*.xml"/>
</beans>
2.4、DispatcherServlet 配置
dispatcher-servlet.xml 主要包含 springMVC 、freemarker、拦截器等配置,具体配置如下:
<?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"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 启用注解驱动的Spring MVC -->
<mvc:annotation-driven/>
<!-- 自动扫描的包 -->
<context:component-scan base-package="org.example"/>
<!-- 处理静态资源 -->
<mvc:default-servlet-handler/>
<!-- <!– 保证静态资源不被拦截 –>-->
<!-- <mvc:resources mapping="/static/**" location="/static/" />-->
<!-- <!– 保证静态资源不被拦截 –>-->
<!-- <mvc:resources mapping="*.html" location="/"/>-->
<!-- 配置视图解析器 start !-->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
<property name="cache" value="true" />
<property name="suffix" value=".ftl" />
<property name="contentType" value="text/html;charset=UTF-8"/>
<property name="requestContextAttribute" value="request" />
<property name="exposeRequestAttributes" value="true"/>
<property name="exposeSessionAttributes" value="true"/>
<property name="exposeSpringMacroHelpers" value="true"/>
<property name="allowRequestOverride" value="true"/>
<property name="allowSessionOverride" value="true"/>
</bean>
<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
<property name="templateLoaderPath" value="/WEB-INF/freemarker/"/>
<property name="defaultEncoding" value="UTF-8" />
<property name="freemarkerSettings">
<bean class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<property name="location" value="classpath:properties/freemarker.properties"/>
</bean>
</property>
</bean>
<!-- 配置视图解析器 end !-->
<!-- 配置拦截器 start !-->
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**" />
<bean class="org.example.web.interceptor.WebHandlerInterceptor" />
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/user/**" />
<bean class="org.example.web.interceptor.WebLoginHandlerInterceptor" />
</mvc:interceptor>
</mvc:interceptors>
<!-- 配置拦截器 end !-->
</beans>
2.5、控制器
创建控制器类 TestController.java,如下所示:
package org.example.web.controller;
import org.springframework.context.annotation.Description;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping("/index")
@Description("index页面!")
public ModelAndView list(HttpServletRequest request,
HttpServletResponse response) {
Map<String, Object> resultMap = new HashMap<String, Object>();
Date nowTime = new Date();
resultMap.put("systemDateTime", nowTime);
return new ModelAndView("/test/index", resultMap);
}
}
2.6、视图
创建视图 /WEB-INF/freemarker/test/index.ftl,如下所示:
<!doctype html>
<html lang="zh-cn">
<head>
<meta charset="utf-8" />
<meta name="viewport"
content="width=device-width, initial-scale=1, viewport-fit=cover" />
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>test/index测试页</title>
</head>
<body>
欢迎您!
</body>
</html>
2.7、拦截器
创建拦截器类 WebHandlerInterceptor.java,spring 拦截器配置请参考 dispatcher-servlet.xml 文件中配置,示例代码如下所示:
package org.example.web.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class WebHandlerInterceptor implements HandlerInterceptor {
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler) throws Exception {
System.out.println("WebHandlerInterceptor->preHandle()");
return true;
}
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("WebHandlerInterceptor->postHandle()");
}
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler,
Exception ex) throws Exception {
System.out.println("WebHandlerInterceptor->afterCompletion()");
}
}
3、搭建持久化层
3.1、配置数据源
resources/spring/spring-database.xml 在此文件中配置数据源,配置如下:
<!-- dataSource Config start -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
<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="defaultAutoCommit" value="${jdbc.defaultAutoCommit}"/>
<!-- 初始化连接大小 -->
<property name="initialSize" value="${jdbc.initialSize}"/>
<!-- 连接池最大使用连接数量 -->
<property name="maxActive" value="${jdbc.maxActive}"/>
<!-- 连接池最小空闲 -->
<property name="minIdle" value="${jdbc.minIdle}"/>
<!-- 获取连接最大等待时间 -->
<property name="maxWait" value="${jdbc.maxWait}"/>
<property name="validationQuery" value="${jdbc.validationQuery}"/>
<property name="testOnBorrow" value="${jdbc.testOnBorrow}"/>
<property name="testOnReturn" value="${jdbc.testOnReturn}"/>
<property name="testWhileIdle" value="${jdbc.testWhileIdle}"/>
<!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 -->
<property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}"/>
<!-- 配置一个连接在池中最小生存的时间,单位是毫秒 -->
<property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}"/>
<!-- 超过时间限制是否回收 -->
<property name="removeAbandoned" value="${jdbc.removeAbandoned}"/>
<!-- 超时时间;单位为秒。180秒=3分钟 -->
<property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}"/>
<!-- 关闭abanded连接时输出错误日志 -->
<property name="logAbandoned" value="${jdbc.logAbandoned}"/>
</bean>
<!-- dataSource Config end -->
<!-- db.properties Config start -->
<!-- <bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">-->
<!-- <property name="location" value="classpath:properties/db.properties"/>-->
<!-- </bean>-->
<context:property-placeholder location="classpath:properties/db.properties"/>
<!-- db.properties Config end -->
3.2、配置 jpa
resources/spring/spring-database.xml 在此文件中配置
<!-- JPA Config start -->
<bean id="entityManagerFactory"
class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="packagesToScan" value="org.example.model"/>
<property name="jpaVendorAdapter">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
<property name="showSql" value="true"/>
<property name="generateDdl" value="true"/>
</bean>
</property>
</bean><!-- JPA实体管理器工厂 -->
<jpa:repositories base-package="org.example.dao.repository"/>
<!-- JPA Config end -->
3.3、配置 mybatis
先配置 resources/mapper/mybatis-config.xml文件
<?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="mapUnderscoreToCamelCase" value="true"/>
</settings>
<typeAliases>
<!--对包进行扫描:获取类名称,将其第一个字母变为小写-->
<package name="org.example.model"/>
</typeAliases>
</configuration>
resources/spring/spring-database.xml 在此文件中配置
<!-- MyBatis Config start -->
<!-- 连接工厂:
id=唯一标识赋 class:Spring封装的类,记住关键字,快捷键导入!SqlSessionFactoryBean;
Spring框架集成,通过 SqlSessionFactoryBean 获得 SqlSessionFactory实例;
-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean" >
<!-- 固定name引用数据源bean -->
<property name="dataSource" ref="dataSource" />
<!-- 固定name通过classpath: 引入mymatis-config.xml,并获取sql映射文件; -->
<property name="configLocation" value="classpath:mapper/mybatis-config.xml" />
<!-- Mapper接口映射xml文件路径 -->
<property name="mapperLocations">
<list>
<value>classpath:mapper/*Mapper.xml</value>
</list>
</property>
</bean>
<!-- MapperScannerConfigurer方式:解决多个Dao映射类;
自动扫描指定包下的Mapper接口,并将它们直接注册为MapperFactoryBean.
Spring会根据它们的接口名命名: 接口AA 默认命名 aA 首字母小写;
basePackage : 指定扫描包下(及包下个层级),所有接口;动态注册为 MapperFactoryBean
sqlSessionFactoryBeanName : 当Spring映射文件中存在多个不同的工厂时候可以指定工厂id名获取;
如果只有一个且名为 SqlSessionFactory 可以默认不写;
-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" >
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
<!-- 自动扫描指定包下的Mapper接口" -->
<property name="basePackage" value="org.example.dao.mapper" />
</bean>
<!-- MyBatis Config end -->
3.4、配置 事务
resources/spring/spring-database.xml 在此文件中配置,因为用到 jpa,因此使用JpaTransactionManager 作为事务管理
<!--开启注解事务-->
<tx:annotation-driven/>
<!-- transactionManager Config start -->
<bean id="transactionManager"
class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory"/>
</bean>
<!-- <bean id="transactionManager"
class="org.springframework.jdbc.datasource.DataSourceTransactionManager" >-->
<!-- <property name="dataSource" ref="dataSource"/>-->
<!-- </bean>-->
<!-- transactionManager Config end -->
3.5、spring-database.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"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:jpa="http://www.springframework.org/schema/data/jpa"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/data/jpa
https://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
<!--开启注解事务-->
<tx:annotation-driven/>
<!-- dataSource Config start -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
<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="defaultAutoCommit" value="${jdbc.defaultAutoCommit}"/>
<!-- 初始化连接大小 -->
<property name="initialSize" value="${jdbc.initialSize}"/>
<!-- 连接池最大使用连接数量 -->
<property name="maxActive" value="${jdbc.maxActive}"/>
<!-- 连接池最小空闲 -->
<property name="minIdle" value="${jdbc.minIdle}"/>
<!-- 获取连接最大等待时间 -->
<property name="maxWait" value="${jdbc.maxWait}"/>
<property name="validationQuery" value="${jdbc.validationQuery}"/>
<property name="testOnBorrow" value="${jdbc.testOnBorrow}"/>
<property name="testOnReturn" value="${jdbc.testOnReturn}"/>
<property name="testWhileIdle" value="${jdbc.testWhileIdle}"/>
<!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 -->
<property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}"/>
<!-- 配置一个连接在池中最小生存的时间,单位是毫秒 -->
<property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}"/>
<!-- 超过时间限制是否回收 -->
<property name="removeAbandoned" value="${jdbc.removeAbandoned}"/>
<!-- 超时时间;单位为秒。180秒=3分钟 -->
<property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}"/>
<!-- 关闭abanded连接时输出错误日志 -->
<property name="logAbandoned" value="${jdbc.logAbandoned}"/>
</bean>
<!-- dataSource Config end -->
<!-- db.properties Config start -->
<!-- <bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">-->
<!-- <property name="location" value="classpath:properties/db.properties"/>-->
<!-- </bean>-->
<context:property-placeholder location="classpath:properties/db.properties"/>
<!-- db.properties Config end -->
<!-- jdbcTemplate Config start -->
<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
<property name="dataSource" ref="dataSource"/>
</bean>
<!-- jdbcTemplate Config end -->
<!-- JPA Config start -->
<bean id="entityManagerFactory"
class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="packagesToScan" value="org.example.model"/>
<property name="jpaVendorAdapter">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
<property name="showSql" value="true"/>
<property name="generateDdl" value="true"/>
</bean>
</property>
</bean><!-- JPA实体管理器工厂 -->
<jpa:repositories base-package="org.example.dao.repository"/>
<!-- JPA Config end -->
<!-- MyBatis Config start -->
<!-- 连接工厂:
id=唯一标识赋 class:Spring封装的类,记住关键字,快捷键导入!SqlSessionFactoryBean;
Spring框架集成,通过 SqlSessionFactoryBean 获得 SqlSessionFactory实例;
-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean" >
<!-- 固定name引用数据源bean -->
<property name="dataSource" ref="dataSource" />
<!-- 固定name通过classpath: 引入mymatis-config.xml,并获取sql映射文件; -->
<property name="configLocation" value="classpath:mapper/mybatis-config.xml" />
<!-- Mapper接口映射xml文件路径 -->
<property name="mapperLocations">
<list>
<value>classpath:mapper/*Mapper.xml</value>
</list>
</property>
</bean>
<!-- MapperScannerConfigurer方式:解决多个Dao映射类;
自动扫描指定包下的Mapper接口,并将它们直接注册为MapperFactoryBean. Spring会根据它们的接口名命名: 接口AA 默认命名 aA 首字母小写;
basePackage : 指定扫描包下(及包下个层级),所有接口;动态注册为 MapperFactoryBean
sqlSessionFactoryBeanName : 当Spring映射文件中存在多个不同的工厂时候可以指定工厂id名获取;如果只有一个且名为 SqlSessionFactory 可以默认不写;
-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" >
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
<!-- 自动扫描指定包下的Mapper接口" -->
<property name="basePackage" value="org.example.dao.mapper" />
</bean>
<!-- MyBatis Config end -->
<!-- transactionManager Config start -->
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory"/>
</bean>
<!-- <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager" >-->
<!-- <property name="dataSource" ref="dataSource"/>-->
<!-- </bean>-->
<!-- transactionManager Config end -->
</beans>
4、编写持久化层
4.1、创建数据库及表
示例中使用 PostgreSQL (ver. 13.5),建表脚本如下:
create table t_user
(
id bigserial not null,
nick_name varchar(20) not null,
user_name varchar(20) not null,
user_pwd varchar(50) not null
);
create unique index t_user_name_uindex
on t_user (user_name);
4.2、实体 model
创建 User.java,如果表名/字段名 对应实体不一致,请用类中注解方式操作,具体代码如下:
package org.example.model;
import javax.persistence.*;
import java.io.Serializable;
@Entity
@Table(name="t_user")
public class User implements Serializable {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(name = "nick_name")
private String nickName;
@Column(name = "user_name")
private String userName;
@Column(name = "user_pwd")
private String userPwd;
public User(){}
public User(String nickName, String userName, String userPwd) {
this.nickName = nickName;
this.userName = userName;
this.userPwd = userPwd;
}
public User(Long id, String nickName, String userName, String userPwd) {
this.id = id;
this.nickName = nickName;
this.userName = userName;
this.userPwd = userPwd;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getNickName() {
return nickName;
}
public void setNickName(String nickName) {
this.nickName = nickName;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getUserPwd() {
return userPwd;
}
public void setUserPwd(String userPwd) {
this.userPwd = userPwd;
}
}
4.3、数据层 dao
jpa方式
创建 org/example/dao/repository/UserRepository.java 文件,内容如下:
package org.example.dao.repository;
import org.example.model.User;
import org.springframework.data.jpa.repository.JpaRepository;
public interface UserRepository extends JpaRepository<User, Long> {
public User findByUserNameAndUserPwd(String user_name, String user_pwd);
}
mybatis 方式
创建 org/example/dao/mapper/UserMapper.java 文件,内容如下:
package org.example.dao.mapper;
import org.example.model.User;
import java.util.List;
import java.util.Map;
public interface UserMapper {
public User queryById(Long id);
public List<User> queryList(Map<String, Object> map);
public int add(User user);
public int remove(Long id);
}
创建 resources/mapper/userMapper.xml 文件,内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "mybatis-3-mapper.dtd" >
<!-- 命名空间,这里是接口的引用,方便面向接口编程,如果是第一种方法可以随意; -->
<mapper namespace="org.example.dao.mapper.UserMapper" >
<select id="queryById" parameterType="java.lang.Long"
resultType="org.example.model.User" >
select * from t_user where id = #{id}
</select>
<select id="queryList" parameterType="java.util.Map"
resultType="org.example.model.User" >
select * from t_user
<where>
<if test="userName != null">
and user_name = #{userName}
</if>
<if test="nickName != null">
and nick_name = #{nickName}
</if>
<if test="userPwd != null">
and user_pwd = #{userPwd}
</if>
</where>
</select>
<insert id="add" parameterType="org.example.model.User">
insert into t_user(nick_name, user_name, user_pwd)
values(#{nickName}, #{userName}, #{userPwd})
</insert>
<delete id="remove" parameterType="java.lang.Long">
delete from t_user where id = #{id}
</delete>
</mapper>
4.4、业务层 service
org/example/service/UserService.java
package org.example.service;
import org.example.model.User;
import java.util.List;
import java.util.Map;
public interface UserService {
public User queryById(Long id);
public User queryByNameAndPwd(String userName, String userPwd);
public List<User> queryList(Map<String, Object> map);
public void add(User user);
public void remove(Long id);
}
org/example/service/impl/UserServiceImpl.java
package org.example.service.impl;
import org.example.dao.mapper.UserMapper;
import org.example.dao.repository.UserRepository;
import org.example.model.User;
import org.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
import java.util.Map;
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
@Autowired
private UserRepository userRepository;
public User queryById(Long id){
System.out.println("UserServiceImpl-> queryById();");
// return userMapper.query(map);
return userRepository.findById(id).orElse(null);
}
public User queryByNameAndPwd(String userName, String userPwd){
System.out.println("UserServiceImpl-> queryByNameAndPwd();");
// Map<String, Object> map = new HashMap<>();
// map.put("userName", userName);
// map.put("userPwd", userPwd);
// List<User> list = queryList(map);
// if(list != null && list.size() > 0){
// return list.get(0);
// }else{
// return null;
// }
return userRepository.findByUserNameAndUserPwd(userName, userPwd);
}
@Override
public List<User> queryList(Map<String, Object> map) {
System.out.println("UserServiceImpl-> queryList();");
// return userMapper.query(map);
return userRepository.findAll();
}
@Override
public void add(User user) {
// userMapper.add(user);
user = userRepository.save(user);
System.out.println("UserServiceImpl->add() " + user.toString());
}
@Override
public void remove(Long id) {
int result = 0;
// result = userMapper.remove(id);
userRepository.deleteById(id);
System.out.println("UserServiceImpl-> remove() result = " + result);
}
}
5、编写控制层
创建 org/example/web/utils/WebUtils.java ,内容如下
package org.example.web.utils;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import freemarker.template.utility.DateUtil;
import org.example.model.User;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
public final class WebUtils {
static final String SYSTEM_CURRENT_TIME_MILLIS = "systemCurrentTimeMillis";
static final String SYSTEM_CURRENT_DATE_TIME = "systemCurrentDateTime";
public static ModelAndView getModelAndView(HttpServletRequest request, HttpServletResponse response, Map<String, Object> resultMap, String viewName){
Date nowTime = new Date();
resultMap.put(SYSTEM_CURRENT_DATE_TIME, nowTime);
resultMap.put(SYSTEM_CURRENT_TIME_MILLIS, nowTime.getTime());
ModelAndView modelAndView = new ModelAndView(viewName, resultMap);
return modelAndView;
}
public static void write(HttpServletResponse response, JSONObject bean){
String result = JSON.toJSONString(bean);
try {
response.setContentType("text/html;charset=utf-8");
// response.getWriter().print(SecureUtil.encode_moble(result, key, iv));
response.getWriter().print(result);
response.getWriter().flush();
response.getWriter().close();
} catch (IOException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
}
public static final String SESSION_INFO = "session_info";
public static final String SESSION_USER_INFO = "session_user_info";
public static void set_session_user_info(HttpServletRequest request, User user){
user.setUserPwd("");
request.getSession().setAttribute(SESSION_USER_INFO, user);
}
public static void remove_session_user_info(HttpServletRequest request){
request.getSession().removeAttribute(SESSION_USER_INFO);
}
public static HttpSession get_session_info(HttpServletRequest request){
return request.getSession();
}
public static User get_session_user_info(HttpServletRequest request){
Object userObj = request.getSession().getAttribute(SESSION_USER_INFO);
if(userObj != null){
return (User) userObj;
}
return null;
}
}
创建 org/example/web/controller/UserController.java ,内容如下:
package org.example.web.controller;
import org.example.model.User;
import org.example.service.UserService;
import org.example.web.utils.WebUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Description;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;
@Controller
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@RequestMapping("/list")
@Description("User->list页面!")
public ModelAndView list(HttpServletRequest request, HttpServletResponse response) {
Map<String, Object> resultMap = new HashMap<String, Object>();
String page_title = "用户-列表页";
resultMap.put("page_title", page_title);
resultMap.put("dataList", userService.queryList(resultMap));
System.out.println("UserController->list()");
return WebUtils.getModelAndView(request, response, resultMap, "user/list");
}
@RequestMapping("/detail/{id}")
@Description("User->detail页面!")
public ModelAndView detail(HttpServletRequest request, HttpServletResponse response, @PathVariable Long id) {
Map<String, Object> resultMap = new HashMap<String, Object>();
String page_title = "用户-详情页";
resultMap.put("page_title", page_title);
resultMap.put("dataObject", userService.queryById(id));
System.out.println("UserController->detail()");
return WebUtils.getModelAndView(request, response, resultMap, "user/detail");
}
@RequestMapping("/add")
@Description("User->add页面!")
public ModelAndView add_index(HttpServletRequest request, HttpServletResponse response) {
Map<String, Object> resultMap = new HashMap<String, Object>();
String page_title = "用户-新增页面";
resultMap.put("page_title", page_title);
System.out.println("UserController->add()");
return WebUtils.getModelAndView(request, response, resultMap, "user/add");
}
@RequestMapping("/save")
@Description("User->save页面!")
public ModelAndView save(HttpServletRequest request, HttpServletResponse response) {
Map<String, Object> resultMap = new HashMap<String, Object>();
String page_title = "用户-操作结果页面";
Boolean page_result = true;
String nickName = request.getParameter("nick_name");
String userName = request.getParameter("user_name");
String userPwd = request.getParameter("user_pwd");
User user = new User(nickName, userName, userPwd);
try {
userService.add(user);
}catch (Exception e){
page_result = false;
e.printStackTrace();
}
resultMap.put("page_title", page_title);
resultMap.put("page_result", page_result);
resultMap.put("page_result_title", page_result ? "操作成功" : "操作失败");
System.out.println("UserController->save()");
return WebUtils.getModelAndView(request, response, resultMap, "user/result");
}
@RequestMapping("/remove/{id}")
@Description("User->remove页面!")
public ModelAndView remove(HttpServletRequest request, HttpServletResponse response, @PathVariable Long id) {
Map<String, Object> resultMap = new HashMap<String, Object>();
String page_title = "用户-操作结果页面";
Boolean page_result = true;
try {
userService.remove(id);
}catch (Exception e){
page_result = false;
e.printStackTrace();
}
resultMap.put("page_title", page_title);
resultMap.put("page_result", page_result);
resultMap.put("page_result_title", page_result ? "操作成功" : "操作失败");
System.out.println("UserController->remove()");
return WebUtils.getModelAndView(request, response, resultMap, "user/result");
}
}
四、项目示例
本文主要展环境搭建的相关配置及主要模块代码,为方便起见将示例上传,方便下载参阅。
代码压缩包在本页顶部!!!

1337

被折叠的 条评论
为什么被折叠?



