⭐ 作者简介:码上言
⭐ 代表教程:Spring Boot + vue-element 开发个人博客项目实战教程
项目部署视频
https://www.bilibili.com/video/BV1sg4y1A7Kv/?vd_source=dc7bf298d3c608d281c16239b3f5167b
文章目录
前言
上一篇讲述的是项目的版本管理,使用Git对项目进行管理,可以多人开发,很好的对项目进行管理。以后我们每写个功能就要提交一次代码,方便以后项目出错或者查找某个功能的实现的记录。本节将讲述项目的各个包的搭建以及含义,然后配置Mybatis数据库管理,和项目日志的搭建。
一、项目包创建
在我们写项目的包是类的一种文件组织和管理方式、是一组功能相似或相关的类或接口的集合。通过包有效的管理java的各种类,每个包名都有自己的含义,接下来我们定义项目中自己的包名。
首先打开项目,可能会出现以下情况,我们把包改成树状的方便查看。去掉之后则变成树状的包,比较方便查看。
接下来,创建包,总目录如下图所示,其中删掉了static 、templates两个文件。
下面分别解释下创建的包的作用。
● config:放一些配置的类,比如Swagger接口文档的配置类等。
● controller:接口层,前端通过接口类进行数据访问,数据暴露出的接口。
● entity:实体类,基本上是一个数据库表一个实体类,里面的字段相对应创建。
● mapper:这个包是放的service层调的数据层的接口,对数据库的操作的接口。
● service:业务类的接口,controller层一般调用的是这个类的接口。
● Impl:业务实现类,处理项目的业务逻辑,在项目中很重要,主要调用的是mapper中的接口。
● util:工具包,例如返回的格式同一类、错误码类等。
● mybatis ->mapper:对数据库操作的xml文件,一个mapper对应一个xml。
二、配置Mybatis
首先简单的介绍一下啥是mybatis,学过的可以直接跳过。
1、mybatis介绍
官方文档:http://mybatis.org/spring/zh/index.html
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里,便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。
2、项目中加入mybatis
项目是使用的Maven 作为构建工具,只需要在 pom.xml 中加入以下依赖即可:
<dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.1.3</version> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency>
添加完之后,然后在resources
的目录下的mybatis文件下建一个配置的xml
文件,当点击创建后,可能会弹出这个对话框,是否加入git
,点击Add
即可,就可以把新建的文件加入到本地的git中。以后创建新的文件都会出现这个提示,都点击Add
即可。然后将以下内容复制到创建的xml中
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <!--是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。--> <setting name="mapUnderscoreToCamelCase" value="false"/> </settings> <!-- MyBatis 在设置预处理语句(PreparedStatement)中的参数或从结果集中取出一个值时, 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型--> <typeHandlers> <typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="java.math.RoundingMode"/> <typeHandler handler="org.apache.ibatis.type.ZonedDateTimeTypeHandler" /> <typeHandler handler="org.apache.ibatis.type.OffsetDateTimeTypeHandler" /> <typeHandler handler="org.apache.ibatis.type.OffsetTimeTypeHandler" /> <typeHandler handler="org.apache.ibatis.type.InstantTypeHandler" /> <typeHandler handler="org.apache.ibatis.type.LocalDateTimeTypeHandler" /> <typeHandler handler="org.apache.ibatis.type.LocalDateTypeHandler" /> </typeHandlers> </configuration>
然后再添加了一个解决Maven项目无法读取src/main/java目录下面的配置文件问题。
<resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*.xml</include> </includes> </resource> </resources>
好啦,配置完后,启动项目,看看控制台是否有错误,没有错误就可以继续开发了。
三、加入log4j日志
1、什么是log4j?
官方文档:https://logging.apache.org/log4j/2.x/几乎每个大型应用程序都包含自己的日志记录或跟踪 API。根据此规则,EU SEMPER项目决定编写自己的跟踪 API。那是在 1996 年初。经过无数次增强、几次化身和大量工作,API 已经发展成为 log4j,一种流行的 Java 日志记录包。该软件包在Apache 软件许可证下分发,Apache 软件许可证是由开源倡议认证的成熟的开源许可证。可以在http://logging.apache.org/log4j/2.x/index.html找到最新的 log4j 版本,包括完整的源代码、类文件和文档。
2、项目中引入Log4j
在项目的pom.xml文件中加入以下依赖。
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>com.lmax</groupId> <artifactId>disruptor</artifactId> <version>${disruptor.version}</version> </dependency>
然后在<properties>
标签中设置版本号
<slf4j.version>1.7.32</slf4j.version> <log4j2.version>2.13.0</log4j2.version> <disruptor.version>3.4.2</disruptor.version>
然后再把springBoot自带默认log配置去掉
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!--去掉SpringBoot默认配置--> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency>
然后点击右上角的刷新,则项目就会自动加载这些依赖。为了防止有些进度跟不上,到目前为止配置文件完整的代码如下。
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.5.5</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.blog</groupId> <artifactId>personal-blog</artifactId> <version>0.0.1-SNAPSHOT</version> <name>personal-blog</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <slf4j.version>1.7.32</slf4j.version> <log4j2.version>2.13.0</log4j2.version> <disruptor.version>3.4.2</disruptor.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!--去掉SpringBoot默认配置--> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.1.3</version> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>${log4j2.version}</version> </dependency> <dependency> <groupId>com.lmax</groupId> <artifactId>disruptor</artifactId> <version>${disruptor.version}</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> <resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*.xml</include> </includes> </resource> </resources> </build> </project>
依赖导入完成后,接下来要新建一个日志的配置文件,规定一些日志文件的名称、存放地址以及一些配置等。
在resources
目录下,新建一个log4j2.xml
的配置文件
然后将以下代码添加进入,里面有代码注释,主要是设置日志的保存路径、log文件的命名问题等操作。
<?xml version="1.0" encoding="UTF-8"?> <Configuration monitorInterval="60"> <Properties> <!-- log文件前缀--> <Property name="filename">blog</Property> <!-- 日志存放路径--> <Property name="log_path">/blogLog/logs</Property> <!-- log文件编码--> <Property name="blogLog_encoding">UTF-8</Property> <!-- log文件大小--> <Property name="blogLog_size">300MB</Property> <!-- log文件自动删除时间--> <Property name="blogLog_time">5d</Property> </Properties> <Appenders> <!-- 系统相关日志 --> <RollingRandomAccessFile name="BLOG_FILE" fileName="${log_path}/${filename}.log" filePattern="${log_path}/${filename}_%d{yyyy-MM-dd}_%i.log.gz"> <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}][%-5p][%t][%c{1}] %m%n"/> <Policies> <SizeBasedTriggeringPolicy size="${blogLog_size}"/> </Policies> </RollingRandomAccessFile> </Appenders> <Loggers> <!-- 系统相关日志 --> <AsyncRoot level="info" includeLocation="true"> <AppenderRef ref="BLOG_FILE" level="info"/> </AsyncRoot> </Loggers> </Configuration>
设置完成后,然后我们启动项目,等待成功启动。如果是以下的情况,则成功启动项目,日志已经加载进来了。
这时我们去项目所在的存储盘中查找我们设置的log保存的文件。
然后打开这个文件,就可以看到启动信息了,以后项目启动不起来首先查找日志报错信息。
好了,到这里项目基本的配置基本上结束了,下面我们要开始接触写代码了,前期铺垫很长,但也都是一个项目所需要的东西,要尽可能的掌握,学习永无止境!
上一篇:Spring Boot + vue-element 开发个人博客项目实战教程(五、项目部署到gitee管理)