现在,我们来搭建一个简单的分模块的 SSM 开发框架吧,
一:分析并创建项目
先来简单分析下我们项目的结构:
比如:我现在搭建一个管理系统,我们把项目分为:
tx-parent 顶级父项目(公司默认有的)|- tx-manager —————————pom.xml 父项目
|- tx-manager-mapper ————— 数据层
|- tx-manager-common ————— 工具层
|- tx-manager-bean ————— 实体层
|- tx-manager-service ————– 服务层
|- tx-manager-web ————— 控制层
至于为什么这么分,我想都应该知道吧,当然是为了代码复用啦。下面我们一个一个的来分析下。
tx-parent 顶级父项目
tx-parent 是我们公司的顶级父项目,是一个 pom.xml,用于管理依赖的。我们这里来看看他的 pom.xml 的问题。
<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.topinfo</groupId>
<artifactId>tx-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<!– 集中定义依赖版本号 –>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<servlet-api.version>2.5</servlet-api.version>
<json-lib.version>2.4</json-lib.version>
<druid.version>1.1.10</druid.version>
<joda-time.version>2.5</joda-time.version>
<commons-lang3.version>3.3.2</commons-lang3.version>
<commons-io.version>1.3.2</commons-io.version>
<commons-net.version>3.3</commons-net.version>
<thymeleaf-layout-dialect.version>2.3.0</thymeleaf-layout-dialect.version>
</properties>
<!– 阿里仓库 –>
<repositories>
<repository>
<id>aliyun-repos</id>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<dependencyManagement>
<!– springboot 的依赖,这里使用导入的方式 –>
<dependencies>
<dependency>
<!– Import dependency management from Spring Boot –>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.1.1.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>nz.net.ultraq.thymeleaf</groupId>
<artifactId>thymeleaf-layout-dialect</artifactId>
<version>${thymeleaf-layout-dialect.version}</version>
</dependency>
<!– 添加 servlet-api 的依赖 –>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>${servlet-api.version}</version>
<scope>provided</scope>
</dependency>
<!– json-lib Json 解析 –>
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
<version>${json-lib.version}</version>
</dependency>
<!– 时间操作组件 –>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>${joda-time.version}</version>
</dependency>
<!– Apache 工具组件 –>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>${commons-lang3.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-io</artifactId>
<version>${commons-io.version}</version>
</dependency>
<dependency>
<groupId>commons-net</groupId>
<artifactId>commons-net</artifactId>
<version>${commons-net.version}</version>
</dependency>
<!– 阿里德鲁伊 连接池 –>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
<!– 分发管理将本项目打成 jar 包, 直接上传到指定服务器 –>
<distributionManagement>
<repository>
<id>topinfo-releases</id>
<name>Topinfo Release Repository</name>
<url>http://192.168.19.82:8081/repository/releases/</url>
</repository>
<snapshotRepository>
<id>topinfo-snapshots</id>
<name>Topinfo Snapshot Repository</name>
<url>http://192.168.19.82:8081/repository/snapshots/</url>
</snapshotRepository>
</distributionManagement>
<build>
<finalName>${project.artifactId}</finalName>
<plugins>
<!– 资源文件拷贝插件 –>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
<!– java 编译插件 –>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.2</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<!– 配置 Tomcat 插件 –>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.2</version>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
tx-manager 项目
tx-manager 这个就是我们的管理项目,他也是一个 pom.xml 项目,主要是用来聚合的,需要继承顶级父项目,然后在依统一的工具项目,最后 pom.xml 文件长这样:
<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>
<parent>
<groupId>com.topinfo</groupId>
<artifactId>tx-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<!– 子项目 –>
<modules>
<module>tx-manager-web</module>
<module>tx-manager-service</module>
<module>tx-manager-bean</module>
<module>tx-manager-mapper</module>
</modules>
<!– 依赖管理 –>
<dependencies>
<dependency>
<groupId>com.topinfo</groupId>
<artifactId>tx-common</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
我想熟悉 maven 的人都知道吧,这应该不用多解释吧。接下来我们继续创建所有项目都创建好,然后在配置他们的 pom.xml 依赖。
tx-manager 的 tx-manager-web 子模块
我们先讲 web 层,因为我想把 springboot 配置在这里也说下。简单分析:1、我们引入 spring-boot-starter-web 的依赖,因为我们要用到 spingmvc2、我们引入 tx-manager-service 依赖,因为我们要调用服务层。3、然后在引入一些其他模板啊,tomcat 内嵌的,测试的
如:
<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>
<parent>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>tx-manager-web</artifactId>
<packaging>war</packaging>
<!– 依赖管理 –>
<dependencies>
<dependency>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager-service</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<!– 打包的时候可以不用包进去,别的会提供。事实上该依赖理论上可以参与编译,测试,运行等周期。
相当于 compile,但是打包阶段做了 exclude 操作 –>
<scope>provided</scope>
</dependency>
<!– 模板 thymeleaf –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>nz.net.ultraq.thymeleaf</groupId>
<artifactId>thymeleaf-layout-dialect</artifactId>
</dependency>
<!–springboot 程序测试依赖,如果是自动创建项目默认添加 –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
</dependency>
</dependencies>
</project>
tx-manager 的 tx-manager-service 子模块
服务层肯定是调用 dao 层,也会调用实体等,具体看 pom.xml
<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>
<parent>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>tx-manager-service</artifactId>
<dependencies>
<!– 公共工具 –>
<dependency>
<groupId>com.topinfo</groupId>
<artifactId>tx-common</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
<!– 依赖 mapper –>
<dependency>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager-mapper</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
<!– 依赖实体 –>
<dependency>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager-bean</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
tx-manager 的 tx-manager-mapper 子模块
tx-manager-mapper,dao 层 pom.xml
<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>
<parent>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>tx-manager-mapper</artifactId>
<dependencies>
<!– 依赖实体 –>
<dependency>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager-bean</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
tx-manager 的 tx-manager-bean 子模块
实体子模块,暂时什么都不依赖
<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>
<parent>
<groupId>com.topinfo.manager</groupId>
<artifactId>tx-manager</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>tx-manager-bean</artifactId>
</project>
这样,整个项目都创建就完成了,上传 svn。长这样:
我们接下来看看每个子模块如何编写。
二:子模块搭建
1:tx-manager-web 子模块搭建
1:tx-manager-web 子模块配置
在将 tx-manager-web 之前,我们先将 SpringBoot 的配置文件,SpringBoot 使用一个全局的配置文件 application.properties 或 application.yml,我们推荐使用 yml 文件。在项目内,SpringBoot 启动会默认扫描以下位置的:application.properties 或 application.yml 文件。
规则:按照优先级从高到低的顺序,所有位置的文件都会被加载,高优先级配置内容如果与低优先级的内容冲突则覆盖,如果不冲突则会去并集。
我们也可以手动的修改其默认读取文件的路径(一般我们不建议做),我们还可以从文件的外部加载,比如:命令行,环境变量等,我们这里不扩展,我们建议使用:类路径 /config 这个目录,如图:
2:tx-manager-web 子模块静态资源
静态资源路径是指系统可以直接访问的路径,且路径下的所有文件均可被用户通过浏览器直接读取。在 Springboot 中默认的静态资源路径有:classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/
我们选择 classpath:/static/,我们把图片、js、css 等静态资源都存放到这个目录中,如图:
在访问的时候,为了在界面中可以访问 js、css 等,还需要对静态资源进行路径映射。如:
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry){
// 静态资源映射
registry.addResourceHandler (“/static/**”).addResourceLocations (“classpath:/static/”);
WebMvcConfigurer.super.addResourceHandlers (registry);
}
}
页面资源通过这样引用
<link rel=”stylesheet” href=”../assets/css/core.css” th:href=”@{/assets/css/core.css}” />
<script type=”text/javascript” src=”../assets/js/lib/jquery-2.1.0.js” th:src=”@{/assets/js/lib/jquery-2.1.0.js}” ></script>
这样页面就可以正常访问了。我这里是去 amazeui 网站去下载了一个 demo,我最好运行效果:
后
OK,界面运行起来了。
完善:
为了 http://192.168.90.51:8080/ 也可以访问到 login.html
添加一个界面跳转的 controller.
/**
* @ClassName: PageController
* @Description: 页面跳转的 Controller
* @author: 杨攀
* @date: 2018 年 12 月 27 日 下午 2:38:36
* @Copyright: 2018 www.tuxun.net Inc. All rights reserved.
*/
@Controller
public class PageController {
/**
* @Description: 打开首页
* @param: @return
* @return: String
*/
@RequestMapping(“/”)
public String showIndex(){
return “login”;
}
/**
* @Description: 其他页面 跳转
* @param: @param page
* @param: @return
* @return: String
*/
@RequestMapping(“/{page}”)
public String showpage(@PathVariable String page){
return page;
}
}
web 层级就先这样,我们接下来处理 dao 层