上一篇讲的是项目的版本管理,使用Git对项目进行管理,可以多人开发,很好的对项目进行管理,以后我们每写一个功能就要提交一次代码,方便以后项目出错时,或者查找某个功能得实现记录,下面介绍项目各个包的搭建及含义,然后配置Mybatis数据库管理和项目日志的搭建。
一、项目包搭建
Java中的包机制,在菜鸟教程中的介绍:https://www.runoob.com/java/java-package.html
包时类的一种文件组织和管理方式,是一组功能相似或相关类或接口的集合,通过包有效的管理java中的各种类,每个包都有自己的含义,接下来我们定义项目中自己的包名
项目的的包以树状呈现
创建包,在某一层处右键->New -> Package
输入创建包的名字,例如util
接下来,创建包,总目录如下,其中删掉了static、templates两个文件
下面解释一下这些包的作用 :
- config:放一些配置类,比如Swagger接口文档的配置类等
- controller:接口层,前端通过接口类进行数据访问,数据暴露出的接口
- entity:实体类,基本上是一个数据表一个实体类,里面的字段相对应创建
- mapper:这个包是放的service层调的数据层的接口,对数据库的操作的接口
- service:业务类的接口,controller层一般调用的是这个类接口
- lmpl:业务实现类,处理项目的业务逻辑,在项目中很重要,主要调用的是mapper中的接口
- util:工具包,例如返回的格式同一类,错误码类等
- mybatis ->mapper:对数据库操作的xml文件,一个mapper对应一个xml
二、配置Mybatis
1. Mybatis介绍
首先看官方文档:mybatis-spring –
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>
在pom.xml中进行添加
点击右侧的Maven,当Dependencies中出现相关依赖说明添加依赖成功
添加完成之后,在resources目录下的mybatis文件下建一个配置的xml文件 ,命名为mybatis-config.xml,在点击创建后,可能会弹出提示框,是否加入git,点击Add加入即可,可以把新建的文件加入到本地的git中,以后创建新文件都会出现这个提示,都点Add即可。
然后将下面的内容复制粘贴到新建的mybatis-config.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>
在mybatis-config.xml中添加
再添加一个解决Maven项目无法读取src/main/java下面配置文件的问题
在pom.xml中添加
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
配置完成之后,点击启动项目,没有报错的话就可以进行下一步了
三、加入log4j日志
1. 什么是log4j
官方文档:Log4j – 阿帕奇 Log4j 2 (apache.org)
几乎每个大型应用程序都包含自己的日志记录或跟踪API,根据此规则EU SEMPER决定编写自己的跟踪API,那是在1996年初,经过无数次增强,几次化身和大量工作,API已经发展成log4j,一种流行的Java日志记录包,该软件包在Apache软件许可证下分发,Apache软件许可证是由开源倡议认证的成熟的开源许可证,可在Log4j – Apache Log4找到最新的logj源代码,包括完整的源代码,类文件和文档
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>
点击右上角的刷新
点击刷新后,点击右侧的Maven中的Dependcies,出现新的依赖,说明添加成功
下面贴出了目前为止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 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.7.1</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.blog</groupId>
<artifactId>person-blog</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>person-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>
依赖导入完成之后,接下来要新建一个日志的配置文件,规定一些日志文件的名称、存放地址以及一些配置等
在resource目录下,新建一个lo4j2.xml文件
将以下代码添加进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>
设置完成之后,我们启动项目,控制台如果是下面这个情况,说明启动成功,日志已经加载进来了
这时我们打开everything查找blogLog,在D盘中生成了一个名为blogLog的文件夹存放打印日志,
点开blog.log,就可以看到启动信息了,以后项目启动不起来,第一时间首先点开日志文件查找报错信息
到这里,项目的基本配置就完成了