基于SSM实现的Java后台开发项目搭建

浅浅的花香味﹌ 2022-07-11 15:23 188阅读 0赞

对于SSM框架的介绍，项目结构的层级分离网上有很多介绍的资料，其实对于SSM框架的整合也有很多的教程，但我还是决定写下来，作为对自己的检查。在整合工程中，数据库使用的是mysql，数据库连接池使用的是HikariCP（HikariCP官网通过对比声称它是目前速度最快的数据库连接池），同时也配置了redis数据库连接池和redis客户端。

### SSM框架整合 ###

SSM整合，我分成了两个配置文件，分别为spring-mvc.xml和applicationContext.xml。同时还有资源文件，jdbc.properties、log4j.properties和redis.properties，另外需要注意的是，jackson导入的包和配置文件在spring3.x和spring4.x下是不一样的。完整目录如下：

![20180210111622398][]

pom.xml，引入常有的Java包

<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/maven-v4_0_0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>cn.scene</groupId>
        <artifactId>cn.scene</artifactId>
        <packaging>war</packaging>
        <version>1.0-SNAPSHOT</version>
        <name>cn.scene Maven Webapp</name>
        <url>http://maven.apache.org</url>
    
        <properties>
            <spring.version>4.3.13.RELEASE</spring.version>
            <mybatis.version>3.4.5</mybatis.version>
            <slf4j.version>1.7.7</slf4j.version>
            <log4j.version>1.2.17</log4j.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>provided</scope>
            </dependency>
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
                <version>${spring.version}</version>
                <scope>provided</scope>
            </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-context-support</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-aop</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.5.4</version>
            </dependency>
            <dependency>
                <groupId>aspectj</groupId>
                <artifactId>aspectjrt</artifactId>
                <version>1.5.4</version>
            </dependency>
            
            <dependency>
                <groupId>javax</groupId>
                <artifactId>javaee-api</artifactId>
                <version>7.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>${mybatis.version}</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
                <version>1.3.1</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.34</version>
            </dependency>
            <dependency>
                <groupId>com.zaxxer</groupId>
                <artifactId>HikariCP</artifactId>
                <version>2.7.4</version>
            </dependency>
            
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
                <version>${slf4j.version}</version>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>${slf4j.version}</version>
            </dependency>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <dependency>
                <groupId>jstl</groupId>
                <artifactId>jstl</artifactId>
                <version>1.2</version>
            </dependency>
            
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-core</artifactId>
                <version>2.8.1</version>
            </dependency>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.8.1</version>
            </dependency>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-annotations</artifactId>
                <version>2.8.1</version>
            </dependency>
            
            <dependency>
                <groupId>commons-fileupload</groupId>
                <artifactId>commons-fileupload</artifactId>
                <version>1.3.1</version>
            </dependency>
            <dependency>
                <groupId>commons-io</groupId>
                <artifactId>commons-io</artifactId>
                <version>2.4</version>
            </dependency>
            <dependency>
                <groupId>commons-codec</groupId>
                <artifactId>commons-codec</artifactId>
                <version>1.10</version>
            </dependency>
            
            <dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>2.9.0</version>
            </dependency>
        </dependencies>
        <build>
            <finalName>cn.scene</finalName>
        </build>
    </project>

applicationContext.xml，整合Spring，Mybatis和Redis

主要实现自动扫描，自动注入和配置数据库，数据库连接池选用Hikari，理解时可参考代码中的注释。

<?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 http://www.springframework.org/schema/context/spring-context-3.1.xsd
               http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
    
        <description>Spring公共配置</description>
    
        
        <context:component-scan base-package="cn.scene" />
    
        
        <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
            <property name="locations">
                <list>
                    <value>classpath:jdbc.properties</value>
                    <value>classpath:redis.properties</value>
                </list>
            </property>
        </bean>
    
        
        <bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource"  destroy-method="close">
            <property name="driverClassName" value="${driver}" />
            <property name="jdbcUrl" value="${url}" />
            <property name="username" value="${username}" />
            <property name="password" value="${password}" />
            
            <property name="readOnly" value="${readOnly}" />
            
            <property name="connectionTimeout" value="${connectionTimeout}" />
            
            <property name="idleTimeout" value="${idleTimeout}" />
            
            <property name="maxLifetime" value="${maxLifetime}" />
            
            <property name="maximumPoolSize" value="${maximumPoolSize}" />
        </bean>
    
        
        <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
            <property name="dataSource" ref="dataSource" />
            <property name="mapperLocations" value="classpath*:/mybatis-mapper/*Mapper.xml" />
            
            <property name="plugins">
                <array>
                    <bean class="com.github.pagehelper.PageHelper">
                        <property name="properties">
                            <value>
                                dialect = mysql
                                reasonable = true
                            </value>
                        </property>
                    </bean>
                </array>
            </property>
        </bean>
    
        <bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
            <constructor-arg index="0" ref="sqlSessionFactory" />
        </bean>
    
        
        <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
            <property name="basePackage" value="cn.scene.dao" />
            <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
        </bean>
    
        
        <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
            <property name="dataSource" ref="dataSource"></property>
        </bean>
        <tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true"/>
    
        
        <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
            
            <property name="maxTotal" value="30" />
            
            <property name="maxIdle" value="10" />
            
            <property name="numTestsPerEvictionRun" value="1024"/>
            
            <property name="timeBetweenEvictionRunsMillis" value="30000" />
            
            <property name="minEvictableIdleTimeMillis" value="1800000" />
            
            <property name="softMinEvictableIdleTimeMillis" value="10000" />
            
            <property name="maxWaitMillis" value="1500" />
            
            <property name="testOnBorrow" value="true" />
            
            <property name="testWhileIdle" value="true" />
            
            <property name="blockWhenExhausted" value="false" />
        </bean>
        
        <bean id="jedisPool" class="redis.clients.jedis.JedisPool" destroy-method="close">
            <constructor-arg name="poolConfig" ref="jedisPoolConfig" />
            <constructor-arg name="host" value="127.0.0.1" />
            <constructor-arg name="port" value="6379" />
            <constructor-arg name="timeout" value="3000" />
            <constructor-arg name="password" value="hsf123456" />
        </bean>
    </beans>

jdbc.properties

driver=com.mysql.jdbc.Driver
    url=jdbc:mysql://localhost:3306/dbName?useUnicode=true&characterEncoding=utf-8
    username=root
    password=123456
    readOnly=false
    connectionTimeout=30000
    idleTimeout=6000000
    maxLifetime=2850000
    maximumPoolSize=15

log4j.properties

为了方便调试，一般都会使用日志来输出信息，Log4j是[Apache][]的一个开放源代码项目，Log4j的配置很简单，而且也是通用的，通过使用Log4j，我们可以控制[日志][Link 1]信息输送的目的地是[控制台][Link 2]、文件、[GUI][]组件，甚至是套接口服务器、[NT][]的事件记录器、[UNIX][] [Syslog][][守护进程][Link 3]等；

#定义LOG输出级别  
    log4j.rootLogger=INFO,Console,File  
    #定义日志输出目的地为控制台  
    log4j.appender.Console=org.apache.log4j.ConsoleAppender  
    log4j.appender.Console.Target=System.out  
    #可以灵活地指定日志输出格式，下面一行是指定具体的格式  
    log4j.appender.Console.layout = org.apache.log4j.PatternLayout  
    log4j.appender.Console.layout.ConversionPattern=[%c] - %m%n  
    #文件大小到达指定尺寸的时候产生一个新的文件  
    log4j.appender.File = org.apache.log4j.RollingFileAppender  
    #指定输出目录  
    log4j.appender.File.File = logs/ssm.log  
    #定义文件最大大小  
    log4j.appender.File.MaxFileSize = 10MB  
    # 输出所以日志，如果换成DEBUG表示输出DEBUG以上级别日志  
    log4j.appender.File.Threshold = ALL  
    log4j.appender.File.layout = org.apache.log4j.PatternLayout  
    log4j.appender.File.layout.ConversionPattern =[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c]%m%n

redis.properties

该文件主要存放redis数据库中的key值，可以通过@Value()注入key值。

#缓存官网首页内容的key
    HOME_INDEX=HOME_INDEX

到这里，便实现了Spring和Mybatis的整合。spring-mvc.xml是整合Spring-mvc的配置文件。主要是自动扫描控制器，视图模式和注解的启动，这里要注意的一点是Controller基础包要改成项目对应目录下的报名，jsp的目录也可自行修改到自己想要的目录。这里我把jsp页面放在了webapp根目录下。具体代码如下：

spring-mvc.xml

接着配置web.xml文件，主要实现对spring-mybatis.xml和spring-mvc的引入，以及添加编码过滤器实现SSM的整合。具体代码如下：

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee"
             xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
             id="WebApp_ID" version="3.0">
        <display-name>Scene Application</display-name>
    
        <listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>
        <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:applicationContext.xml</param-value>
        </context-param>
        <servlet>
            <servlet-name>mvc</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                <param-value>classpath:spring-mvc.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>mvc</servlet-name>
            <url-pattern>*.html</url-pattern>
        </servlet-mapping>
        
        <filter>
            <filter-name>encodingFilter</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>encodingFilter</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>
    
        <welcome-file-list>
            <welcome-file>index.html</welcome-file>
            <welcome-file>index.jsp</welcome-file>
        </welcome-file-list>
    </web-app>

至此，便是完成了SSM的整合，具体代码已托管github：[SSM框架整合][SSM]

[20180210111622398]: /images/20220711/919cb85eedfe4b7d8ebb4edd5cc9ffec.png
[Apache]: http://baike.baidu.com/subview/28283/5418753.htm
[Link 1]: http://baike.baidu.com/view/269351.htm
[Link 2]: http://baike.baidu.com/view/135167.htm
[GUI]: http://baike.baidu.com/view/25309.htm
[NT]: http://baike.baidu.com/subview/378/5113303.htm
[UNIX]: http://baike.baidu.com/view/8095.htm
[Syslog]: http://baike.baidu.com/view/1614723.htm
[Link 3]: http://baike.baidu.com/view/53123.htm
[SSM]: https://github.com/Hongsf/SSM