说明:
(1)本篇博客内容:简单介绍该项目的工程结构,简单介绍聚合工程;同时,创建该项目的顶级父工程【imooc-news-dev】
(2)如果对于使用Maven构建聚合工程等内容熟悉,可以参考【(商) 附加1:Maven;】中的内容;
目录
一:项目工程结构(该项目是个聚合工程),简介;
二: 创建顶级父工程【imooc-news】 ;
1.创建顶级父工程【imooc-news-dev】 ;
2.顶级父工程【imooc-news-dev】的,pom.xml ;
一:项目工程结构(该项目是个聚合工程),简介;
说明:
(1)这儿,我们会借助maven来帮助构建项目;
(2)因为这个项目是一个微服务的分布式项目,所以我们会使用maven构建一个聚合工程;
● PS:即使我们的项目不是微服务项目,在目前开发中,我们往往也会分层的去构建项目,也就是聚合工程;
(3)【imooc-news】就是顶级工程;
● 在顶级工程之内,有其他的几个基础工程(也就是顶级工程中的一个一个的module模块);
● 【common】这个子工程(或称模块):包含一些基础的组件、util工具类、枚举类等等基础的东西;
● 【model】这个子工程(或称模块):包含一些entity、pojo、VO类等类;
● 【api】这个子工程(或称模块):api就代表接口;;;该项目所有的接口都会在【api】这个工程中进行管理;;;比如,我们在做SpringBoot项目的时候,所有的接口都是Controller层的;;;但是,因为我们这个是微服务项目,所以所有的微服务接口都会统一在【api】中管理;;;比如后面的Swagger、拦截器等,都是可以以【api】为抓手的;;;(PS:在下一篇博客,演示【api接口暴露】的时候,会对这一点理解的更深)
(4)这个项目有很多微服务(一般,具体的服务,其工程名会以service开头);
● 这些服务也是【imooc-news】这个顶级工程之内的,一个一个子工程(或称模块);
● 这些服务(我们一般可以使用SpringBoot去实现)中,自然也有Controller,我么可以在Controller中编写接口;;;只不过,这些服务在Controller中编写内容,都是对【api这个子工程中,定义的接口】的实现(这也是我们这个项目的组织方式);
● 其实,这些微服务,都是一个完整的项目,都是可以独立的去部署的;;;这些微服务中,也都有各自的Controller、Service和Dao;(自然,对于一个一个单独的微服务来说,我么也可以根据Controller、Service和Dao,继续进行拆分;;;;只不过,一般不这么做;)
说明:
(1)这儿,我们会借助maven来帮助构建项目;
(2)因为这个项目是一个微服务的分布式项目,所以我们会使用maven构建一个聚合工程;
● PS:即使我们的项目不是微服务项目,在目前开发中,我们往往也会分层的去构建项目,也就是聚合工程;
(3)【imooc-news】就是顶级工程;
● 在顶级工程之内,有其他的几个基础工程(也就是顶级工程中的一个一个的module模块);
● 【common】这个子工程(或称模块):包含一些基础的组件、util工具类、枚举类等等基础的东西;
● 【model】这个子工程(或称模块):包含一些entity、pojo、VO类等类;
● 【api】这个子工程(或称模块):api就代表接口;;;该项目所有的接口都会在【api】这个工程中进行管理;;;比如,我们在做SpringBoot项目的时候,所有的接口都是Controller层的;;;但是,因为我们这个是微服务项目,所以所有的微服务接口都会统一在【api】中管理;;;比如后面的Swagger、拦截器等,都是可以以【api】为抓手的;;;(PS:在下一篇博客,演示【api接口暴露】的时候,会对这一点理解的更深)
(4)这个项目有很多微服务(一般,具体的服务,其工程名会以service开头);
● 这些服务也是【imooc-news】这个顶级工程之内的,一个一个子工程(或称模块);
● 这些服务(我们一般可以使用SpringBoot去实现)中,自然也有Controller,我么可以在Controller中编写接口;;;只不过,这些服务在Controller中编写内容,都是对【api这个子工程中,定义的接口】的实现(这也是我们这个项目的组织方式);
● 其实,这些微服务,都是一个完整的项目,都是可以独立的去部署的;;;这些微服务中,也都有各自的Controller、Service和Dao;(自然,对于一个一个单独的微服务来说,我么也可以根据Controller、Service和Dao,继续进行拆分;;;;只不过,一般不这么做;)
二: 创建顶级父工程【imooc-news】 ;
1.创建顶级父工程【imooc-news-dev】 ;
2.顶级父工程【imooc-news-dev】的,pom.xml ;
pom.xml:
4.0.0
com.imooc
imooc-news-dev
1.0-SNAPSHOT
pom
org.springframework.boot
spring-boot-starter-parent
2.2.5.RELEASE
UTF-8
UTF-8
1.8
5.1.41
2.1.0
2.1.5
1.2.12
4.2.2
2.10.2
1.11
3.4
1.4
28.2-jre
2.4.0
1.6
1.27.2
1.7.21
2.10.6
org.springframework.cloud
spring-cloud-dependencies
Hoxton.SR3
pom
import
org.mongodb
mongodb-driver
3.11.1
mysql
mysql-connector-java
${mysql-connector-java.version}
org.mybatis.spring.boot
mybatis-spring-boot-starter
${mybatis-spring-boot-starter.version}
tk.mybatis
mapper-spring-boot-starter
${mapper-spring-boot-starter.version}
com.github.pagehelper
pagehelper-spring-boot-starter
${pagehelper-spring-boot-starter.version}
com.squareup.okhttp3
okhttp
${okhttp.version}
com.fasterxml.jackson.core
jackson-core
${jackson.version}
com.fasterxml.jackson.core
jackson-annotations
${jackson.version}
com.fasterxml.jackson.core
jackson-databind
${jackson.version}
commons-codec
commons-codec
${commons-codec.version}
org.apache.commons
commons-lang3
${commons-lang3.version}
commons-fileupload
commons-fileupload
${commons-fileupload.version}
com.google.guava
guava
${google-guava.version}
io.springfox
springfox-swagger2
${springfox-swagger2.version}
io.springfox
springfox-swagger-ui
${springfox-swagger2.version}
com.github.xiaoymin
swagger-bootstrap-ui
${swagger-bootstrap-ui.version}
com.github.tobato
fastdfs-client
${fastdfs.version}
joda-time
joda-time
${joda-time.version}
${project.artifactId}
org.apache.maven.plugins
maven-compiler-plugin
1.8
1.8
UTF-8
说明:
(1)【imooc-news-dev】是个“什么具体业务也不做”的顶级工程,所以其pom.xml中设为pom ;
(2)PS:如果对于使用Maven构建聚合工程等内容熟悉,可以参考【(商) 附加1:Maven;】中的内容;
(3)在通过【(商) 附加1:Maven;】深入了解了maven之后,回顾【Spring Boot入门三:创建Spring Boot项目;】、【Spring Boot电商项目8:数据库设计与项目初始化三:创建Spring Boot项目;使用【mybatis-generator】插件生成实体类、mapper接口、mapper.xml等逆向文件;】和本篇博客才发现:我们通过maven这个工具来创建Spring Boot项目时候,这个工程的父工程是需要指定为【spring-boot-starter-parent】;
● 目前可以这样认为(这个理解可能存在偏差、甚至是错误的地方):一个工程只要符合Spring Boot工程的各项特征和要求,这个工程就可以是一个Spring Boot项目;;;我们通过【Spring 官网start.spring.io,方式】、【IDEA集成的Spring Initializr,方式】都可以创建一个Spring Boot项目;;;自然,我们直接创建一个maven项目,通过引入依赖、设置配置文件、设置启动类等方式,也可以把这个项目变成一个Spring Boot项目;
(4)我们这个项目,Spring Boot使用2.2.5.RELEASE版本;
● Spring Boot版本和Spring Cloud版本之间,是有一定的关联性的:可以参考【https://spring.io/projects/spring-cloud#overview】;
(5) 中定义的是属性;
(6)依赖说明:Spring Cloud依赖,MongoDB依赖;
(7)依赖说明:MySQL驱动;
● Spring Boot项目(起码是2.2版本以后的),其MySQL驱动版本默认是8.x,而自己电脑上安装的MySQL正是8.x版本的;这也是为什么以前在自己电脑上做spring Boot项目的时候,自己并没有设置MySQL驱动版本,而是直接使用默认版本的原因;
● 因为,自己将使用MariaDB,所以,这儿我们就不能使用默认版本的了,而是要手动指定使用5.1.41版本的;
(8)依赖说明:mybatis依赖,【mapper-spring-boot-starter】依赖;
● 以前在【Spring Boot电商项目8:数据库设计与项目初始化三:创建Spring Boot项目;使用【mybatis-generator】插件生成实体类、mapper接口、mapper.xml等逆向文件;】中,当时是使用【mybatis-generator】插件来逆向生成实体类、mapper接口、mapper.xml等文件的;
● 这儿,我们使用的【mapper-spring-boot-starter】和【mybatis-generator插件】是不同的;关于【mapper-spring-boot-starter】可以参考【MyBatis-Spring-Boot-Starter简要说明】;后面使用到的时候,再详细介绍;
(9)依赖说明:pagehelper分页;
● 一开始,在非spring的web项目中,接触到的分页是mybatis的PageHelper分页插件,可以参考【MyBatis进阶五:PageHelper分页插件;】
● 后来在spring MVC项目,整合Mybatis-Plus的时候,接触了Mybatis-Plus的分页插件,可以参考【SSM开发书评网7:项目准备与SSM整合五:Mybatis-Plus简介;SSM整合Mybatis-Plus;】,其中介绍了在Spring MVC项目中,配置Mybatis-Plus,以及Mybatis-Plus的分页插件;
● 再后来,在spring Boot项目中,我们使用的还是mybatis的PageHelper分页插件,可以参考【Spring Boot电商项目29:商品分类模块八:后台的【分类列表(平铺)】接口;(重点是,在Spring Boot项目中,使用PageHelper分页插件;)】;只是,因为这是个mybatis和Spring一起的项目,而Spring为了能整合Mybatis做了很多工作,所以当时引入的依赖就是这样的;
● 我们这个项目虽然是Spring Cloud项目,但是具体的每个微服务使用【Spring Boot】去具体实现的,再加上我们ORM框架是mybatis,自然就可以使用PageHelpe了;
(10)依赖说明:okhttp依赖;(作用是,服务与服务之间发送rest请求)
(11)依赖说明:Jackson三件套;
(12)依赖说明:apache工具类【commons-codec】、【commons-lang3】、【commons-fileupload】;
● 【commons-codec】是apache提供的数据的编码/解码组件,可以使用【Commons Codec】来实现MD5的;具体可以参考【OA系统十三:基于【MD5算法】+【加盐混淆】策略:对密码进行加密;】;
● 【commons-lang3】是Apache提供的一个java.lang包的增强版本,Lang3为java.lang API提供了许多帮助程序实用程序,特别是字符串操作方法,基本数值方法,对象反射,并发,创建和序列化以及系统属性。此外,它还包含对java.util.Date的基本增强,以及一系列专用于构建方法的实用程序,例如hashCode,toString和equals。(后面用到的时候,再集体介绍吧)
● 【commons-fileupload】是一款apache提供的文件上传组件;;;可以参考【后台系统四:【新增】功能;(FileUpload组件)】;这个组件和spring没有半毛钱关系;;;但是,在【Spring Boot电商项目35:商品模块二:【增加商品】接口之图片上传:【上传图片】接口开发;】中,当时我们开发SpringBoot项目的时候,并没有使用FileUpload组件;而是使用Spring提供的【@RequestParam("file") MultipartFile file】的方式,来实现文件的接收;;;
(13)依赖说明:谷歌工具类【guava】;
● 有关【guava】的简介,可以参考【Guava概述】;
(14)依赖说明:【swagger】;
● 以前接触过【swagger】,可以参考【Spring Boot电商项目25:商品分类模块四:使用Swagger自动生成API文档;】及附近相关文章;
● 其中【swagger-bootstrap-ui 】是一个基于swagger的前端UI实现,是为了替换了默认的swagger-ui,让生成的文档更加友好和美观;
(15)依赖说明:【fastdfs-client】;
● fastdfs是文件上传的一个工具;
(16)依赖说明:【joda-time】;
● joda-time是一个时间工具类;可以参考【Joda-Time日期时间工具类】;
(17)插件:【maven-compiler-plugin】,maven的编译器级别;
● maven的编译器级别,即我们的项目是需要使用jdk1.8去编译的;而,如果我们不设置的话,如果重启IDEA的话,其编译级别可能回退到1.5;尤其是如果是使用eclipse的话,更可能出现这种情况;
● 关于这点,以前遇到过两次:【Maven七:Maven构建Web工程(基于Eclipse);并测试;】;【OA系统四:前期准备二:在工程中集成Mybatis;开发MybatisUtils工具类;】;
(18)顺带提一句吧,其实在【(商) 附加1:Maven;】中已经介绍的很清楚了;
● 父工程pom.xml中的,其作用仅仅是规定依赖,那些写在其中的依赖并不会被真正的下载;;只有子工程用到的时候,才会下载;
● 使用的目的,是为了保证父工程的干净,也就是说父工程只负责管理依赖以及依赖的版本,而不会导入额外的jar包依赖;;;;即,父工程的职责很单一,这也体现了面向对象开发的父子 继承关系(即父工程和子工程,在职责这样方面,有点像接口和实现类的感觉);
(19)重复强调一下:项目的maven要使用自己安装的maven,而不要使用IDEA自带的maven;
1.创建顶级父工程【imooc-news-dev】 ;
2.顶级父工程【imooc-news-dev】的,pom.xml ;
pom.xml:
4.0.0 com.imooc imooc-news-dev1.0-SNAPSHOT pom org.springframework.boot spring-boot-starter-parent2.2.5.RELEASE UTF-8 UTF-8 1.8 5.1.41 2.1.0 2.1.5 1.2.12 4.2.2 2.10.2 1.11 3.4 1.4 28.2-jre 2.4.0 1.6 1.27.2 1.7.21 2.10.6 org.springframework.cloud spring-cloud-dependenciesHoxton.SR3 pom import org.mongodb mongodb-driver3.11.1 mysql mysql-connector-java${mysql-connector-java.version} org.mybatis.spring.boot mybatis-spring-boot-starter${mybatis-spring-boot-starter.version} tk.mybatis mapper-spring-boot-starter${mapper-spring-boot-starter.version} com.github.pagehelper pagehelper-spring-boot-starter${pagehelper-spring-boot-starter.version} com.squareup.okhttp3 okhttp${okhttp.version} com.fasterxml.jackson.core jackson-core${jackson.version} com.fasterxml.jackson.core jackson-annotations${jackson.version} com.fasterxml.jackson.core jackson-databind${jackson.version} commons-codec commons-codec${commons-codec.version} org.apache.commons commons-lang3${commons-lang3.version} commons-fileupload commons-fileupload${commons-fileupload.version} com.google.guava guava${google-guava.version} io.springfox springfox-swagger2${springfox-swagger2.version} io.springfox springfox-swagger-ui${springfox-swagger2.version} com.github.xiaoymin swagger-bootstrap-ui${swagger-bootstrap-ui.version} com.github.tobato fastdfs-client${fastdfs.version} joda-time joda-time${joda-time.version} ${project.artifactId} org.apache.maven.plugins maven-compiler-plugin1.8 1.8 UTF-8
说明:
(1)【imooc-news-dev】是个“什么具体业务也不做”的顶级工程,所以其pom.xml中
(2)PS:如果对于使用Maven构建聚合工程等内容熟悉,可以参考【(商) 附加1:Maven;】中的内容;
(3)在通过【(商) 附加1:Maven;】深入了解了maven之后,回顾【Spring Boot入门三:创建Spring Boot项目;】、【Spring Boot电商项目8:数据库设计与项目初始化三:创建Spring Boot项目;使用【mybatis-generator】插件生成实体类、mapper接口、mapper.xml等逆向文件;】和本篇博客才发现:我们通过maven这个工具来创建Spring Boot项目时候,这个工程的父工程是需要指定为【spring-boot-starter-parent】;
● 目前可以这样认为(这个理解可能存在偏差、甚至是错误的地方):一个工程只要符合Spring Boot工程的各项特征和要求,这个工程就可以是一个Spring Boot项目;;;我们通过【Spring 官网start.spring.io,方式】、【IDEA集成的Spring Initializr,方式】都可以创建一个Spring Boot项目;;;自然,我们直接创建一个maven项目,通过引入依赖、设置配置文件、设置启动类等方式,也可以把这个项目变成一个Spring Boot项目;
(4)我们这个项目,Spring Boot使用2.2.5.RELEASE版本;
● Spring Boot版本和Spring Cloud版本之间,是有一定的关联性的:可以参考【https://spring.io/projects/spring-cloud#overview】;
(5)
(6)依赖说明:Spring Cloud依赖,MongoDB依赖;
(7)依赖说明:MySQL驱动;
● Spring Boot项目(起码是2.2版本以后的),其MySQL驱动版本默认是8.x,而自己电脑上安装的MySQL正是8.x版本的;这也是为什么以前在自己电脑上做spring Boot项目的时候,自己并没有设置MySQL驱动版本,而是直接使用默认版本的原因;
● 因为,自己将使用MariaDB,所以,这儿我们就不能使用默认版本的了,而是要手动指定使用5.1.41版本的;
(8)依赖说明:mybatis依赖,【mapper-spring-boot-starter】依赖;
● 以前在【Spring Boot电商项目8:数据库设计与项目初始化三:创建Spring Boot项目;使用【mybatis-generator】插件生成实体类、mapper接口、mapper.xml等逆向文件;】中,当时是使用【mybatis-generator】插件来逆向生成实体类、mapper接口、mapper.xml等文件的;
● 这儿,我们使用的【mapper-spring-boot-starter】和【mybatis-generator插件】是不同的;关于【mapper-spring-boot-starter】可以参考【MyBatis-Spring-Boot-Starter简要说明】;后面使用到的时候,再详细介绍;
(9)依赖说明:pagehelper分页;
● 一开始,在非spring的web项目中,接触到的分页是mybatis的PageHelper分页插件,可以参考【MyBatis进阶五:PageHelper分页插件;】
● 后来在spring MVC项目,整合Mybatis-Plus的时候,接触了Mybatis-Plus的分页插件,可以参考【SSM开发书评网7:项目准备与SSM整合五:Mybatis-Plus简介;SSM整合Mybatis-Plus;】,其中介绍了在Spring MVC项目中,配置Mybatis-Plus,以及Mybatis-Plus的分页插件;
● 再后来,在spring Boot项目中,我们使用的还是mybatis的PageHelper分页插件,可以参考【Spring Boot电商项目29:商品分类模块八:后台的【分类列表(平铺)】接口;(重点是,在Spring Boot项目中,使用PageHelper分页插件;)】;只是,因为这是个mybatis和Spring一起的项目,而Spring为了能整合Mybatis做了很多工作,所以当时引入的依赖就是这样的;
● 我们这个项目虽然是Spring Cloud项目,但是具体的每个微服务使用【Spring Boot】去具体实现的,再加上我们ORM框架是mybatis,自然就可以使用PageHelpe了;
(10)依赖说明:okhttp依赖;(作用是,服务与服务之间发送rest请求)
(11)依赖说明:Jackson三件套;
(12)依赖说明:apache工具类【commons-codec】、【commons-lang3】、【commons-fileupload】;
● 【commons-codec】是apache提供的数据的编码/解码组件,可以使用【Commons Codec】来实现MD5的;具体可以参考【OA系统十三:基于【MD5算法】+【加盐混淆】策略:对密码进行加密;】;
● 【commons-lang3】是Apache提供的一个java.lang包的增强版本,Lang3为java.lang API提供了许多帮助程序实用程序,特别是字符串操作方法,基本数值方法,对象反射,并发,创建和序列化以及系统属性。此外,它还包含对java.util.Date的基本增强,以及一系列专用于构建方法的实用程序,例如hashCode,toString和equals。(后面用到的时候,再集体介绍吧)
● 【commons-fileupload】是一款apache提供的文件上传组件;;;可以参考【后台系统四:【新增】功能;(FileUpload组件)】;这个组件和spring没有半毛钱关系;;;但是,在【Spring Boot电商项目35:商品模块二:【增加商品】接口之图片上传:【上传图片】接口开发;】中,当时我们开发SpringBoot项目的时候,并没有使用FileUpload组件;而是使用Spring提供的【@RequestParam("file") MultipartFile file】的方式,来实现文件的接收;;;
(13)依赖说明:谷歌工具类【guava】;
● 有关【guava】的简介,可以参考【Guava概述】;
(14)依赖说明:【swagger】;
● 以前接触过【swagger】,可以参考【Spring Boot电商项目25:商品分类模块四:使用Swagger自动生成API文档;】及附近相关文章;
● 其中【swagger-bootstrap-ui 】是一个基于swagger的前端UI实现,是为了替换了默认的swagger-ui,让生成的文档更加友好和美观;
(15)依赖说明:【fastdfs-client】;
● fastdfs是文件上传的一个工具;
(16)依赖说明:【joda-time】;
● joda-time是一个时间工具类;可以参考【Joda-Time日期时间工具类】;
(17)插件:【maven-compiler-plugin】,maven的编译器级别;
● maven的编译器级别,即我们的项目是需要使用jdk1.8去编译的;而,如果我们不设置的话,如果重启IDEA的话,其编译级别可能回退到1.5;尤其是如果是使用eclipse的话,更可能出现这种情况;
● 关于这点,以前遇到过两次:【Maven七:Maven构建Web工程(基于Eclipse);并测试;】;【OA系统四:前期准备二:在工程中集成Mybatis;开发MybatisUtils工具类;】;
(18)顺带提一句吧,其实在【(商) 附加1:Maven;】中已经介绍的很清楚了;
● 父工程pom.xml中的
● 使用
(19)重复强调一下:项目的maven要使用自己安装的maven,而不要使用IDEA自带的maven;



