快速搭建SSM基本项目

快速搭建SSM项目基本手脚架

Maven构建项目

一般我们使用Maven来管理我们的项目:
20210902153454

导入相关依赖配置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>WebApp</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>WebApp Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <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.9.RELEASE</spring-version>
    <junit-version>4.13</junit-version>
    <servlet-api-version>2.5</servlet-api-version>
    <spring-core-version>${spring-version}</spring-core-version>
    <spring-beans-version>${spring-version}</spring-beans-version>
    <spring-context-version>${spring-version}</spring-context-version>
    <spring-tx-version>${spring-version}</spring-tx-version>
    <spring-aspects-version>${spring-version}</spring-aspects-version>
    <spring-jdbc-version>${spring-version}</spring-jdbc-version>
    <spring-web-version>${spring-version}</spring-web-version>
    <spring-webmvc-version>${spring-version}</spring-webmvc-version>
    <mybatis-version>3.5.3</mybatis-version>
    <mybatis-spring-version>2.0.3</mybatis-spring-version>
    <mysql-version>8.0.23</mysql-version>
    <slf4j-log4j12-vsersion>1.7.25</slf4j-log4j12-vsersion>
  </properties>

  <dependencies>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>${slf4j-log4j12-vsersion}</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>${junit-version}</version>
      <scope>compile</scope>
    </dependency>

    <!-- servlet-api的依赖 -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>${servlet-api-version}</version>
      <scope>provided</scope>
    </dependency>

    <!-- spring-core的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring-core-version}</version>
    </dependency>

    <!-- spring-beans的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>${spring-beans-version}</version>
    </dependency>

    <!-- spring-context的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring-context-version}</version>
    </dependency>

    <!-- spring-tx的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>${spring-tx-version}</version>
    </dependency>

    <!-- spring-aspects的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aspects</artifactId>
      <version>${spring-aspects-version}</version>
    </dependency>

    <!-- spring-jdbc的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>${spring-jdbc-version}</version>
    </dependency>

    <!-- spring-web的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring-web-version}</version>
    </dependency>

    <!-- spring-webmvc的依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring-webmvc-version}</version>
    </dependency>

    <!-- mybatis的核心依赖 -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>${mybatis-version}</version>
    </dependency>

    <!-- mybatis-spring的依赖 -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>${mybatis-spring-version}</version>
    </dependency>

    <!--  添加mysql依赖  -->
    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>${mysql-version}</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>
  <build>
    <!--
    有时候,比如mybatis的mapper.xml文件,我们习惯把它和Mapper.java放一起,都在src/main/java下面,这样利用maven打包时,
    就需要修改pom.xml文件,来把mapper.xml文件一起打包进jar或者war里了,否则,这些文件不会被打包的。
    -->
    <!-- 资源目录 -->
    <resources>
      <resource>
        <!-- 设定主资源目录 -->
        <directory>src/main/java</directory>
        <!-- 需要读取的文件 -->
        <includes>
          <include>**/*.xml</include>
        </includes>
      </resource>
    </resources>
  </build>
</project>

配置项目相关文件

在main目录下的resources下创建配置文件:

  • 数据库相关配置文件:db.properties:
m_driver=com.mysql.cj.jdbc.Driver
m_user=root
m_pwd=root
m_url=jdbc:mysql://localhost:3306/rbac
  • Spring IoC容器配置文件:applicationContext.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:aop="http://www.springframework.org/schema/aop"
       xmlns:tx="http://www.springframework.org/schema/tx"
       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
                           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">
    <!-- 加载解析jdbc.properties的标签 -->
    <context:property-placeholder location="classpath:db.properties"/>
    <!-- service层的注解扫描 -->
    <context:component-scan base-package="com.lyl.service.impl"/>
    <!-- 配置数据源bean -->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="${m_driver}"/>
        <property name="url" value="${m_url}"/>
        <property name="username" value="${m_user}"/>
        <property name="password" value="${m_pwd}"/>
    </bean>
    <!-- 配置SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 配置UserMapper扫描 -->
    <bean id="mapper" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.lyl.mapper"/>
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    </bean>
    <!-- 配置事务管理器 -->
    <bean id="tx" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 配置事务管理通知 -->
    <tx:advice id="txManager" transaction-manager="tx">
        <tx:attributes>
            <tx:method name="sel*" read-only="true"/>
            <tx:method name="del*"/>
            <tx:method name="up*"/>
            <tx:method name="ins*"/>
        </tx:attributes>
    </tx:advice>
    <!-- 用AOP将事务管理通知切入方法 -->
    <aop:config>
        <aop:pointcut id="my" expression="execution(* com.lyl.service.impl.*.*(..))"/>
        <aop:advisor advice-ref="txManager" pointcut-ref="my"/>
    </aop:config>
</beans>
  • 配置Spring MVC容器配置文件:springmvc-config.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/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">
    <context:component-scan base-package="com.lyl.controller"/>

    <mvc:annotation-driven/>
    <!-- 定义视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
    <!-- 静态文件放行,该文件夹下的文件会放行 -->
    <mvc:resources mapping="/static/**" location="/static/"/>
</beans>
  • 日志文件:log4g.properties
log4j.rootLogger=error,CONSOLE,LOGFILE
log4j.logger.com.lyl.mapper=debug
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=- %m%n
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=e:/test1.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=[mybatis_study][%p] [%-d{yyyy-MM-dd HH\:mm\:ss}] %C.%M(%L) | %m%n
  • web.xml文件
<?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_4_0.xsd"
         version="4.0">
    <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:springmvc-config.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>mvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!-- Spring容器的拦截器 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:applicationContext.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>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

构建项目目录

当我们配置文件写完时就开始构建我们的项目目录结构:

20210902190936

后面添加了log4j.properties配置文件

开始测试SSM项目搭建是否完成

Test代码:

@Test
public void testMVC(){
    ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
    String[] beanDefinitionNames = context.getBeanDefinitionNames();
    for (String beanDefinitionName : beanDefinitionNames) {
        System.out.println(beanDefinitionName);
    }
}

打印结果:

org.springframework.context.support.PropertySourcesPlaceholderConfigurer#0
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
dataSource
sqlSessionFactory
mapper
tx
txManager
org.springframework.aop.config.internalAutoProxyCreator
my
org.springframework.aop.support.DefaultBeanFactoryPointcutAdvisor#0

由此可见我们的Spring IoC容器已经搭建完成

开启tomcat看Spring mvc是否能执行,创建Controller:

@Controller
@RequestMapping("hello")
public class HelloController {
    @RequestMapping("say")
    public ModelAndView say(){
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("hello");
        modelAndView.addObject("name","张三");
        return modelAndView;
    }
}

创建两个jsp页面

index.jsp里面包含跳转,到hello.jsp

<html>
<body>
    <h2>Hello World!</h2>
</body>
    <h1>Hello</h1>
    <a href="hello/say">Jump</a>
</html>

hello.jsp

<%
    String path = request.getContextPath();
    String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + path + "/";
%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <base href="<%=basePath%>"/>
    <title>Title</title>
    <script type="text/javascript" src="static/jquery.min.js"></script>
    <script type="text/javascript">
    </script>
</head>
<body>
<h1>你好啊!!!!!!${name}</h1>
</body>
</html>

跳转后如下:

20210902195055

证实Spring MVC容器正常运行

到此,我们的SSM基本框架已经搭建完成,我们只需要前面四个步骤即可

用Maven构建项目-->配置相关配置文件-->创建项目目录结构-->测试是否可以正常运行

关键步骤是配置文件,配置文件一定要书写正确,否则可能出现运行错误!

用MyBatis-Plus帮助我们搭建一键生成代码和目录结构

如果我们在SSM项目中添加了MP工具,则会让我们对数据库操作得心应手,简单明了,MP中有一个插件是代码生成器——AutoGenerator,可以通过官网了解详情。

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

首先我们先导入MP的依赖:

<!-- mybatisPlus的依赖 -->
    <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus -->
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus</artifactId>
      <version>${mybatisPlus-version}</version>
    </dependency>
    <!-- MP的代码生成器依赖 -->
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>${mybatis-plus-generator-version}</version>
    </dependency>
    <!-- 代码生成的模板 -->
    <dependency>
      <groupId>org.apache.velocity</groupId>
      <artifactId>velocity-engine-core</artifactId>
      <version>${velocity-engine-core-version}</version>
    </dependency>
  </dependencies>

然后开始编写代码生成器的代码,

@Test
    public void testCode(){
        AutoGenerator ag = new AutoGenerator();
        String path = System.getProperty("user.dir");// 动态获取当前项目路径
        //1. 全局配置
        GlobalConfig config = new GlobalConfig();
        /*
         * GlobalConfig主要配置的属性有:
         * -- 是否支持AR模式
         * -- 生成代码结构的根路径
         * -- 文件是否覆盖
         * -- 主键策略
         * -- 生成基本的resultMap
         * -- 生成基本的SQL片段,也就是xml文件中的sql标签,包含了表中的字段名
         */
        // 是否支持AR模式
        config.setActiveRecord(true)
                .setAuthor("Clean")
                // 生成路径
                .setOutputDir(path+"/src/main/java")
                // 文件覆盖
                .setFileOverride(false)
                // 主键策略
                .setIdType(IdType.AUTO)
                // 设置日期格式          
                .setDateType(DateType.ONLY_DATE)
                // 去掉Service接口的首字母I,默认Service是以I开头的
                .setServiceName("%sService")
                //生成基本的resultMap
                .setBaseResultMap(true)
                //生成基本的SQL片段
                .setBaseColumnList(true);

        //2. 数据源配置
        /*
         * DataSourceConfig的主要属性配置
         * 此处为MP连接数据库读取数据库中表的属性和字段名,帮我们自动生成项目结构和数据库中表对应的实体类
         * -- 数据库类型
         */
        DataSourceConfig dsConfig = new DataSourceConfig();
        // 设置数据库类型
        dsConfig.setDbType(DbType.MYSQL)
                .setDriverName("com.mysql.cj.jdbc.Driver")
                .setUrl("jdbc:mysql://localhost:3306/spring")
                .setUsername("root")
                .setPassword("root");

        //3. 策略配置globalConfiguration中
        /*
         * StrategyConfig的主要属性配置
         * -- 全局大写命名
         * -- 数据库表映射到实体类的命名策略
         * -- 生成表(要生成实体类的表名,支持多表·11一起生成,以数组的形式填写)
         * -- 设置表的前缀(TablePrefix)
         */
        StrategyConfig stConfig = new StrategyConfig();
        //全局大写命名
        stConfig.setCapitalMode(true)
                // 数据库表映射到实体的命名策略
                .setNaming(NamingStrategy.underline_to_camel)
                // 生成的表, 支持多表一起生成,以数组形式填写
                .setInclude("t_user","t_role","r_menu","t_menu")
                // 设置表的前缀
                .setTablePrefix("t_","r_");

        //4. 包名策略配置
        /*
         * PackageConfig的主要属性配置
         * 公共包--Parent
         */
        PackageConfig pkConfig = new PackageConfig();
        pkConfig.setParent("com.lyl")
                .setMapper("mapper")
                .setService("service")
                .setController("controller")
                .setEntity("pojo")
                .setXml("mapper");

        //5. 整合配置
        /*
         * 整合需要的对象有:
         * --> GlobalConfig
         * --> DataSourceConfig
         * --> StrategyConfig
         * --> PackageConfig
         */
        ag.setGlobalConfig(config)
                .setDataSource(dsConfig)
                .setStrategy(stConfig)
                .setPackageInfo(pkConfig);
        //6. 执行
        ag.execute();
        System.out.println("======= 代码生成完毕 ========");

执行前项目结构:

20210902230844

执行后项目如下:

20210902231026

并且我们的mapper层已经继承了MP的BaseMapper,service层继承了IService,pojo继承了Model,所有的基础代码已经帮我们写好了,我们只需要专注的实现业务逻辑代码即可,其他的基本代码MP已经帮我们实现了,大部分SQL操作我们都可以借助MP提供的Mapper层或Service层的CRUD接口直接调用即可。

小结

我们每一次搭建SSM框架,一开始都是搭建最基本的SSM项目模型,这个过程大部分代码和步骤都是相同的,每次搭建SSM框架都需要重复大量基本工作,我们可以将配置文件中的通用代码用文件保存或直接存在idea中,如果项目中出现了大量的表,mapper,我们就可以借助MP帮我们实现代码的生成,大大节省了开发的时间,让我们专心在业务代码中!

posted @ 2021-09-02 23:21  CN_DADA  阅读(845)  评论(2编辑  收藏  举报