SSM Spring SpringMVC Mybatis 框架搭建并完整的配置

项目结构

|--o2o/src
        |--main
            |--java/com.andyxuuu.o2o/
                |--dao
                |--dto
                |--entity
                |--service
                |--controller
                |--enums
                |--interceptor
                |--utils
            |--resources
                |--spring
                |--mapper
            |--webapp
                |--WEB-INF
                |--resources
        |--test
            |--java
            |--resources
            

dependencies项目依赖

  • spring core spring框架基础核心
<!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring beans 配置、创建和管理bean以及进行依赖反转以及依赖注入操作
<!-- https://mvnrepository.com/artifact/org.springframework/spring-beans -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-beans</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring context 封装大量常用功能扩展
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring jdbc 访问jdbc的封装
<!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring tx 事务管理
<!-- https://mvnrepository.com/artifact/org.springframework/spring-tx -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-tx</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring web web应用开发核心类的封装
<!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • spring webmvc mvc框架的封装
<!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.2.4.RELEASE</version>
</dependency>
  • javax.servlet-api servlet服务
<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope>
</dependency>
  • jackson-databind json解析
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.10.3</version>
</dependency>
  • commons-collections map工具,对collections扩展
<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-collections4 -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-collections4</artifactId>
    <version>4.4</version>
</dependency>
  • mybatis orm框架
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.4</version>
</dependency>
  • mybatis-spring mybatis和spring中间件
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.4</version>
</dependency>
  • mysql-connector-java java数据库连接器
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.19</version>
</dependency>
  • c3p0 连接池
<!-- https://mvnrepository.com/artifact/com.mchange/c3p0 -->
<dependency>
    <groupId>com.mchange</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.5.5</version>
</dependency>
  • logback 日志服务
<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
  • spring test 测试相关的封装
<!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>5.2.4.RELEASE</version>
    <scope>test</scope>
</dependency>
  • junit 测试
<!-- https://mvnrepository.com/artifact/junit/junit -->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13</version>
    <scope>test</scope>
</dependency>

项目配置

数据库连接

o2o/src/main/resources/jdbc.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/o2o?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
jdbc.username=root
jdbc.password=123456

mybatis配置

o2o/src/main/resources/mybatis-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTO Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!--    配置全局属性-->
    <settings>
        <!--        使用jdbc的自增主键-->
        <setting name="useGeneratedKeys" value="true"/>
        <!--        使用列标签替换列名-->
        <setting name="useColumnLabel" value="true"/>
        <!--        开启驼峰命名转换-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>

Spring 数据库连接配置

o2o/src/main/resources/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
       http://www.springframework.org/schema/context/spring-context.xsd">
    <!--mybatis和spring整合配置-->
    <!--    1. 配置数据库相关参数的属性文件-->
    <context:property-placeholder location="classpath:jdbc.properties" />
    <!--    2. 配置数据库连接池 c3p0-->
    <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"/>
        <!--        关闭连接后不自动commit-->
        <property name="autoCommitOnClose" value="false"/>
        <!--        连接超时时间-->
        <property name="checkoutTimeout" value="10000"/>
        <!--        连接失败重试次数-->
        <property name="acquireRetryAttempts" value="2"/>
    </bean>

    <!--    3. 配置SqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--        配置连接池-->
        <property name="dataSource" ref="dataSource"/>
        <!--        配置mybatis全局配置文件-->
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <!--        配置需要扫描的entity实体包-->
        <property name="typeAliasesPackage" value="com.andyxuuu.o2o.entity"/>
        <!--        配置需要扫描的mapping文件-->
        <property name="mapperLocations" value="classpath:mapping/*.xml"/>
    </bean>

    <!--    4. 配置扫描Dao接口包,动态实现Dao接口并注入到Spring容器中-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--        注入sqlSessionFactory-->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
        <!--        配置需要扫描的包-->
        <property name="basePackage" value="com.andyxuuu.o2o.dao"/>
    </bean>
</beans>

Spring 服务相关配置

o2o/src/main/resources/spring/spring-service.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"
       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
       http://www.springframework.org/schema/tx
       http://www.springframework.org/schema/tx/spring-tx.xsd">
    <!--    1. 配置需要扫描注解的service包-->
    <context:component-scan base-package="com.andyxuuu.o2o.service"/>
    <!--    2. 配置事务管理器-->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!--        注入数据库连接池-->
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!--    3. 配置基于注解的声明式事务-->
    <tx:annotation-driven transaction-manager="transactionManager"/>
</beans>

Spring MVC Web相关配置

o2o/src/main/resources/spring/spring-web.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:mvc="http://www.springframework.org/schema/mvc"
       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/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <!--    1. 开启SpringMVC注解模式-->
    <mvc:annotation-driven/>
    <!--    2. 静态资源配置-->
    <!--    resources标记为静态资源-->
    <mvc:resources mapping="/resources/**" location="/resources/"/>
    <!--    使用servlet的默认配置来处理静态资源-->
    <mvc:default-servlet-handler/>
    <!--    3. 定义视图解析器-->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--        把前端资源放在WEB-INF/html文件夹里面,展示的时候去掉这个文件夹路径-->
        <!--        保证外部无法使用文件名来访问到WEB-INF/html下的文件-->
        <property name="prefix" value="/WEB-INF/html/"/>
        <!--        java web的前端文件为jsp,把后缀统一更换为html-->
        <property name="suffix" value=".html"/>
    </bean>
    <!--    4. 扫描web相关bean包-->
    <context:component-scan base-package="com.andyxuuu.o2o.controller"/>
</beans>

java web app配置

o2o/src/main/webapp/WEB-INF/web.xml

<!--    设置配置文件路径-->
    <servlet>
        <servlet-name>spring-dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <!--            将spring文件夹下面的所有spring开头的文件全部加载-->
            <param-value>classpath:spring/spring-*.xml</param-value>
        </init-param>
    </servlet>
    <!--    配置路由映射-->
    <servlet-mapping>
        <servlet-name>spring-dispatcher</servlet-name>
        <!--        默认匹配所有的请求-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

验证配置

  • 配置junit和spring测试整合 src/main/test/com.andyxuuu.o2o/BaseTest.java
/**
 * 配置spring和junit测试整合,junit测试加载的时候启动Spring容器
 */
@RunWith(SpringJUnit4ClassRunner.class)
//配置Spring的配置文件
@ContextConfiguration({
        "classpath:spring/spring-dao.xml",
        "classpath:spring/spring-service.xml"
})
public class BaseTest {
}

验证Dao

  • 定义AreaDao数据库接口类
/**
 * Area数据库配置接口
 */
public interface AreaDao {
    /**
     * 查询所有区域
     * @return Area List
     */
    List<Area> queryAreaList();
}
  • 配置mapping src/main/resources/mapping/AreaDao.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTO Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--需要映射的对象-->
<mapper namespace="com.andyxuuu.o2o.dao.AreaDao">
    <!--    需要映射的方法以及返回值并给出对应的查询语句-->
    <select id="queryAreaList" resultType="com.andyxuuu.o2o.entity.Area">
        SELECT 'area_id','name','priority','create_time','last_edit_time','grade','parent_id'
        FROM tb_area
        ORDER BY 'priority' DESC
    </select>
</mapper>
  • 测试Dao的配置是否正确
//继承基类的配置
public class AreaDaoTest extends BaseTest {
    //注入areaDao
    @Autowired
    private AreaDao areaDao;

    //具体的测试方法
    @Test
    public void testQueryArea() {
        List<Area> areaList = areaDao.queryAreaList();
        //对比查询的数量是否是4个   这个需要自己填充一下测试数据
        assertEquals(4, areaList.size());
    }
}

验证Services

  • 创建服务接口 /src/main/java/com.andyxuuu.o2o/service/AreaService
/**
 * 定义Area服务接口
 */
public interface AreaService {
    /**
     * 获取所有的Area
     * @return Area List
     */
    List<Area> getAreaList();
}
  • 实现接口 /src/main/java/com.andyxuuu.o2o/service/impl/AreaServiceImpl
/**
 * AreaService服务的实现
 */
//标注该类为Service实现类
@Service
public class AreaServiceImpl implements AreaService {

    //注入AreaDao
    @Autowired
    private AreaDao areaDao;

    //实现getAreaList
    @Override
    public List<Area> getAreaList() {
        return areaDao.queryAreaList();
    }
}
  • 测试接口 /src/main/test/com.andyxuuu.o2o/service/AreaServiceTest
/**
 * 继承配置文件
 */
public class AreaServiceTest extends BaseTest {
    //注入AreaService
    @Autowired
    private AreaService areaService;

    //具体测试方法
    @Test
    public void testServiceAreaList() {
        List<Area> areaList = areaService.getAreaList();
        assertEquals(4, areaList.size());
    }
}

验证Controller

  • 创建控制器 /src/main/java/com.andyxuuu.o2o/controller/AreaController
//标注为Controller
@Controller
//AreaController路由映射到/admin地址
@RequestMapping("/admin")
public class AreaController {

    @Autowired
    private AreaService areaService;

    //获取所有Area
    //配置具体的路由映射 /admin/arealist 方法为GET
    @RequestMapping(value = "arealist", method = RequestMethod.GET)
    //标记直接返回结果
    @ResponseBody
    private Map<String, Object> getListArea() {
        Map<String, Object> resultMap = new HashMap<>();
        try {
            List<Area> areaList = areaService.getAreaList();
            resultMap.put("arealist", areaList);
        } catch (Exception e) {
            resultMap.put("success", false);
            resultMap.put("msg", e.getMessage());
        }
        return resultMap;
    }
}

过程中遇到的一些问题

  • 时间问题

datetime占用8个字节,存储时间1000-9999年不受时间影响 timestamp 占用4个字节,在2038后会出现溢出问题,在java进程时间、tomcat和mysql版本和启动时间问题上也会导致时间不一致,还会受到时区的影响。datetime在jdk8以后使用新的api获取值LocalDateTime.now()或者OffsetDateTime.比较稳妥的方法:

  1. 设置Java服务进程的时区为UTC,在边界将时间转换成UTC时间之后,内部无需再考虑时区问题,逻辑简单,性能也好。
@Configuration
public class UTCTimeZoneConfiguration implements ServletContextListener {
    public void contextInitialized(ServletContextEvent event) {
        System.setProperty("user.timezone", "UTC");
        TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
    }

    public void contextDestroyed(ServletContextEvent event) {}
}
  1. API入参和返回值大胆使用JDK8的OffsetDateTime类型,SpringBoot和mybatis也有良好的支持。
  2. 数据库URL设置serverTimezone=UTC,字段使用datetime类型,使用SQL语句更加方便。
jdbc:mysql://127.0.0.1:3306/xxx?serverTimezone=UTC
  1. 本地时间交给前端或者SDK转换。根据用户的时区,随时切换到对应的本地时间。
  • long问题

java long类型对应mysql的BIGINT

  • web app 版本问题
  1. 在IDEA里面选择 Project Structure
  2. 把原来的WebModuleDeploymentDescriptor删除掉,然后重新选择版本添加

常用注解

项目地址:https://gitee.com/andyxuuu/o2o

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
禁止转载,如需转载请通过简信或评论联系作者。

推荐阅读更多精彩内容