Springmvc+Spring+Mybatis+Freemarker+druid+log4j2 全註解配置

時間 2019-12-07

標籤 springmvc+spring+mybatis+freemarker+druid+log4j2 springmvc spring mybatis freemarker druid log 註解配置欄目 Spring 简体版

原文原文鏈接

前言：對於使用配置文件已經有了必定經驗的初學者來講，應該體驗一下使用註解做爲配置文件的感覺，一下我用本身的經驗來配置一份最簡單但同時也全面的配置。

一、目錄結構

目錄結構應該是搭建項目的說明中首先說明的東西，這是涉及到學習者對總體結構瞭解的一個前提。
java

二、pom文件配置

<?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.cogitationsoft</groupId>
    <artifactId>findit</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>findit Maven Webapp</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <encoding>UTF-8</encoding>
        <java.version>1.8</java.version>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <junit.version>4.12</junit.version>
        <spring.version>4.3.14.RELEASE</spring.version>
        <servlet.api.version>3.1.0</servlet.api.version>
        <fastjson.version>1.2.46</fastjson.version>
        <mybatis.version>3.4.1</mybatis.version>
        <mybatis.spring.version>1.3.0</mybatis.spring.version>
        <mysql.connector.version>5.1.41</mysql.connector.version>
        <pagehelper.version>5.1.2</pagehelper.version>
        <log4j.version>2.10.0</log4j.version>
        <druid.version>1.1.9</druid.version>
        <freemarker.version>2.3.23</freemarker.version>
        <jackson.version>2.5.4</jackson.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
        <!--spring reply on -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</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</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-tx</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-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!--servlet-api-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>${servlet.api.version}</version>
            <scope>provided</scope>
        </dependency>

        <!-- /com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>${fastjson.version}</version>
        </dependency>

        <!-- log4j-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <!-- mybatis 和 mysql -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>${pagehelper.version}</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.connector.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>${mybatis.spring.version}</version>
        </dependency>

        <!-- database connection pool -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${druid.version}</version>
        </dependency>

        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>${freemarker.version}</version>
        </dependency>
        <!-- Jackson Json處理工具包 -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>${jackson.version}</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>findit</finalName>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                    </configuration>
                </plugin>
                <!-- Config: Maven Tomcat Plugin -->
                <!-- http://mvnrepository.com/artifact/org.apache.tomcat.maven/tomcat7-maven-plugin%20-->
                <plugin>
                    <groupId>org.apache.tomcat.maven</groupId>
                    <artifactId>tomcat7-maven-plugin</artifactId>
                    <version>2.2</version>
                    <!-- Config: contextPath and Port (Default: /SpringMVCFreeMarker : 8080) -->
                    <configuration>
                        <path>/</path>
                        <port>8080</port>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
</project>

三、web.xml配置

這裏須要作一個說明，由於在全註解配置的配置文件中, web.xml 並非必須要的，但也能夠保留，而且web.xml也能夠作簡單的應用。mysql

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
                      http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1"
         metadata-complete="false">
    <display-name>Archetype Created Web Application</display-name>
    <welcome-file-list>
        <welcome-file></welcome-file>
    </welcome-file-list>
</web-app>

若是你保留了web.xml配置文件那麼必須把 metadata-complete設置爲fasle。能夠設置welcome-file來做爲根目錄的首頁，固然你也能夠經過Controller去設置。git

四、Log4j2配置信息

官方文檔中有這樣的說明，當你是用Log4j2的時候會自動加載classpath下的名爲圖片中的那些配置文件，而且按照1~10是有優先級的，取名的時候要注意這個問題，而且在2.x開始到2.4是不支持properties的配置的，默認使用xml配置，在2.4以後又新加回了properties配置。詳細配置請看官方文檔。github

#屬性表示log4j2自己的日誌信息打印級別
status = DEBUG
#若是犯錯，url，路徑等結果輸出到strerr中
dest = err
#log4j 2.6 以前和 以後的 配置不一樣 ，2.6 以後 ，當第一次使用 identifiers 列表時,
#再也不須要 指定 name。可是若是你要使用多個，仍然要指定
name = PropertiesConfig
# 指定日誌文件的位置和文件名稱,以便記錄多份日誌時,直接引用
property.filename = E:/target/logs

# 級別過濾（過濾日誌記錄）
filter.threshold.type = ThresholdFilter
# 只記錄debug級別以上的日誌，大小寫無關：(ALL<)TRACE<DEBUG<INFO<WARN<ERROR<FATAL(<OFF)
filter.threshold.level = debug

# 控制檯類型的日誌輸出源
appender.console.type = Console
# 輸出源的名稱
appender.console.name = STDOUT
# 輸出佈局類型
appender.console.layout.type = PatternLayout
# 控制檯輸出編碼
appender.console.layout.charset=UTF-8
# 輸出模板
appender.console.layout.pattern =%d %p %C{1.} [%t] %m%n
appender.console.filter.threshold.type = ThresholdFilter
appender.console.filter.threshold.level = debug

# 文件滾動記錄類型的日誌輸出源
appender.rolling.type = RollingFile
# 指定當前滾動輸出源的名稱
appender.rolling.name = RollingFile
# 指定當前日誌文件的位置和文件名稱,能夠單獨指定,也能夠直接引用以前定義過得property.filename參數
appender.rolling.fileName = ${filename}/findit.log
# 指定當發生Rolling時，文件的轉移和重命名規則
appender.rolling.filePattern = ${filename}/findit-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz
# 滾動記錄輸出源佈局類型
appender.rolling.layout.type = PatternLayout
# 日誌文件輸出編碼
appender.rolling.layout.charset=UTF-8
# 滾動記錄輸出模板
appender.rolling.layout.pattern = %d %p %C{1.} [%t] %m%n
# 指定記錄文件的封存策略，該策略主要是完成周期性的日誌文件封存工做
appender.rolling.policies.type = Policies
# 基於時間的觸發策略（TriggeringPolicy）
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
# 當前記錄週期爲每2秒生成一個文件，若是filePattern中配置的文件重命名規則是target/rolling2/test1-%d{yyyy-MM-dd HH-mm}-%i，最小的時間粒度是mm，即分鐘，TimeBasedTriggeringPolicy指定的size是1，結合起來就是每2分鐘生成一個新文件。若是改爲%d{yyyy-MM-dd HH}，最小粒度爲小時，則每2個小時生成一個文件。
appender.rolling.policies.time.interval = 2
# 是否對封存時間進行調製。若modulate=true，則封存時間將以0點爲邊界進行偏移計算。好比，modulate=true，interval=4hours，那麼假設上次封存日誌的時間爲03:00，則下次封存日誌的時間爲04:00，以後的封存時間依次爲08:00，12:00，16:00
appender.rolling.policies.time.modulate = true
# 基於日誌文件體積的觸發策略。
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
# 當日志文件體積大於size指定的值時，觸發Rolling
appender.rolling.policies.size.size=100MB
# 文件封存的覆蓋策略（RolloverStrategy）
appender.rolling.strategy.type = DefaultRolloverStrategy
# 生成分割（封存）文件的個數，默認爲5(-1,-2,-3,-4,-5)
appender.rolling.strategy.max = 5
# 設置字符集編碼
appender.rolling.Encoding=UTF-8

# 記錄器名稱
logger.rolling.name = com.example.my.app
# 設置打印級別（日誌級別）
logger.rolling.level = debug
# 是否向上級logger傳遞打印信息
logger.rolling.additivity = false
# 關聯名稱爲RollingFile的輸出源（appender）
logger.rolling.appenderRef.rolling.ref = RollingFile

# 根記錄器，全部記錄器的父輩
rootLogger.level = info
# 關聯名稱爲STDOUT的輸出源（appender）
rootLogger.appenderRef.stdout.ref = STDOUT
# 關聯名稱爲RollingFile的輸出源（appender）
rootLogger.appenderRef.rolling.ref = RollingFile

五、 Web容器初始化配置

package com.cogitationsoft.findit.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

/**
 * @author: Andy
 * @date: 5/2/2018 11:34 AM
 * @description: BaseConfig WebApplicationInitializer
 * @version: 1.0
 */
public class ApplicationInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {



    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{RootConfig.class};
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

六、根配置信息

package com.cogitationsoft.findit.config;

import org.springframework.context.annotation.*;
import org.springframework.core.type.filter.RegexPatternTypeFilter;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import java.util.regex.Pattern;

/**
 * @author: Andy
 * @date: 5/3/2018 5:11 PM
 * @description: 根配置信息, 用於加載SpringIoc Context
 * @version: 1.0
 */
@Configuration
@ComponentScan(basePackages = {"com.cogitationsoft.findit"}, excludeFilters = {
        @ComponentScan.Filter(type = FilterType.CUSTOM, value = RootConfig.WebPackage.class)
})
@EnableTransactionManagement
@PropertySource("classpath:log4j2.properties")
@Import(MyBatisConfig.class)
public class RootConfig{
    // 內部類，用來排除 web 相關的包，由於這些包已經在 WebConfig 中導入了
    public static class WebPackage extends RegexPatternTypeFilter {
        public WebPackage() {
            super(Pattern.compile("org\\.acherie\\.web"));
        }
    }
}

七、SpringMvc配置

package com.cogitationsoft.findit.config;        
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.ViewResolver;
    import org.springframework.web.servlet.config.annotation.*;
    import org.springframework.web.servlet.view.InternalResourceViewResolver;
    import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;
    import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
    
    /**
     * @author: Andy
     * @date: 5/2/2018 2:20 PM
     * @description: SpringMVC starter
     * @version: 1.0
     */
    @Configuration
    @EnableWebMvc
    @ComponentScan("com.cogitationsoft.findit")
    public class WebConfig extends WebMvcConfigurerAdapter{
    
        /**
         * Method Description:
         * 〈配置視圖解析器〉
         *
         * @param:      null
         * @return:     ViewResolver
         * @author:     Andy
         * @date:       5/3/2018 4:05 PM
         */
        @Bean
        public ViewResolver viewResolver(){
            InternalResourceViewResolver resolver = new InternalResourceViewResolver();
            resolver.setPrefix("/WEB-INF/views/");
            resolver.setSuffix(".ftl");
            resolver.setExposeContextBeansAsAttributes(true);
            return resolver;
        }
    
        /**
         * Method Description:
         * 〈配置Freemarker〉
         *
         * @param:      null
         * @return:
         * @author:     Andy
         * @date:       5/3/2018 4:07 PM
         */
        @Override
        public void configureViewResolvers(ViewResolverRegistry registry) {
            registry.enableContentNegotiation(new MappingJackson2JsonView());
            registry.freeMarker().cache(false);
        }
        @Bean
        public FreeMarkerConfigurer freeMarkerConfigurer() {
            FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
            configurer.setTemplateLoaderPath("/WEB-INF/views/");
            return configurer;
        }
    
        /**
         * Method Description:
         * 〈靜態資源位置〉
         *
         * @param:      ResourceHandlerRegistry 靜態資源處理器註冊
         * @return:     void
         * @author:     Andy
         * @date:       5/3/2018 4:45 PM
         */
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
            registry.addResourceHandler("/resources/**").addResourceLocations("/public-resources/");
        }        
    }

八、 Mybatis 及 druid基本配置

package com.cogitationsoft.findit.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.apache.ibatis.mapping.Environment;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * @author: Andy
 * @date: 5/3/2018 5:57 PM
 * @description: Mybatis 配置信息
 * @version: 1.0
 */
@Configuration
@EnableTransactionManagement
@PropertySource("classpath:config/druid.properties")
@MapperScan("com.cogitationsoft.findit.mapper")
public class MyBatisConfig {
    @Autowired(required = false)
    public Environment env;

    @Value("${druid.driverClassName}")
    private String driver;

    @Value("${druid.url}")
    private String url;

    @Value("${druid.username}")
    private String username;

    @Value("${druid.password}")
    private String password;

    @Value("${druid.initialSize}")
    private int initialSize;

    @Value("${druid.minIdle}")
    private int minIdle;

    @Value("${druid.maxActive}")
    private int maxActive;

    @Value("${druid.maxWait}")
    private int maxWait;

    @Value("${druid.timeBetweenEvictionRunsMillis}")
    private int timeBetweenEvictionRunsMillis;

    @Value("${druid.minEvictableIdleTimeMillis}")
    private int minEvictableIdleTimeMillis;

    @Bean(initMethod = "init", destroyMethod = "close")
    public DruidDataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        // 基本屬性 url、user、password
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);

        // 配置初始化大小、最小、最大
        dataSource.setInitialSize(initialSize);
        dataSource.setMinIdle(minIdle);
        dataSource.setMaxActive(maxActive);

        // 配置獲取鏈接等待超時的時間
        dataSource.setMaxWait(maxWait);

        // 配置間隔多久才進行一次檢測，檢測須要關閉的空閒鏈接，單位是毫秒
        dataSource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

        // 配置一個鏈接在池中最小生存的時間，單位是毫秒
        dataSource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);

        dataSource.setValidationQuery("SELECT 'X'");
        dataSource.setTestWhileIdle(true);
        dataSource.setTestOnBorrow(false);
        dataSource.setTestOnReturn(false);

        // 是否打開PSCache，而且指定每一個鏈接上PSCache的大小
        dataSource.setPoolPreparedStatements(false);
        dataSource.setMaxPoolPreparedStatementPerConnectionSize(20);
        return dataSource;
    }

    @Bean
    public SqlSessionFactory sqlSessionFactory(ApplicationContext applicationContext) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource());
        // 設置 mapper xml
        //sessionFactory.setMapperLocations(applicationContext.getResources("classpath:mapper/**/*.xml"));
        return sessionFactory.getObject();
    }

    @Bean
    public PlatformTransactionManager txManager() {
        return new DataSourceTransactionManager(dataSource());
    }
}

九、基於druid和jdbc配置的屬性文件（數據庫應用的是mysql）

druid.driverClassName=com.mysql.jdbc.Driver
druid.url=jdbc:mysql://127.0.0.1:3306/db_findit?useUnicode=true&characterEncoding=UTF-8&useSSL=false
druid.username=root
druid.password=root
druid.initialSize=10
druid.minIdle=6
druid.maxActive=50
druid.maxWait=60000
druid.timeBetweenEvictionRunsMillis=60000
druid.minEvictableIdleTimeMillis=300000
druid.validationQuery=SELECT 'x'
druid.testWhileIdle=true
druid.testOnBorrow=false
druid.testOnReturn=false
druid.poolPreparedStatements=false
druid.maxPoolPreparedStatementPerConnectionSize=20
druid.filters=wall,stat

十、mapper.xml文件

說明：這裏使用的是xml好像並不符合全配置的本意，可是在mabatis使用的靈活性上來看，若是使用註解的形式並不合適。而且官方也不建議使用javaConfig的形式，何況用java直接寫sql也並非什麼優雅的事，雖然官方提供了sqlbuilder，我仍是認爲這是一件很愚蠢的事。web

<?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="com.cogitationsoft.findit.mapper.DemoMapper">
    <insert id="insert" parameterType="com.cogitationsoft.findit.pojo.DemoDO">
        insert into t_demo (id, no, name)
        values (#{id}, #{no}, #{name})
    </insert>
</mapper>
這裏只用了一個插入的方法。

關於配置的東西到這裏其實就完成了，才疏學淺，若是有大神看見問題還請指正。下面是github的連接，能夠看完整的代碼。
https://github.com/WHXGIT/demospring

因同步時出現問題，請把全部文件放入到findIt文件夾下用idea打開項目。sql