Springboot学习总结笔记（四）最佳实践

一、引入SpringBoot的两种方法

由于分布式系统中需要用到自定义的parent，所以一般使用第二种

1、使用spring-boot-starter-parent

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.2.RELEASE</version>
</parent>

2、引入spring-boot-dependencies

 <dependencyManagement>
      <dependencies>
            <dependency>
                <!-- Import dependency management from Spring Boot -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>1.5.2.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
     </dependencies>
</dependencyManagement>

 

二、Springboot单元测试

   <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-test</artifactId>
   </dependency>

@SpringBootTest
@RunWith(SpringRunner.class)
public class DemoTest {
	@Autowired
	RedisService redisService;
	@Test
	public void Demo() {
		System.out.println(redisService.id());
	}
}

 

三、项目结构

1、src/main/java  程序开发以及主程序入口
2、src/main/resources 配置文件
3、src/test/java  测试程序

src/main/java根目录下面，有如下Java类和包：

公共模块

• common：公共类，如枚举，常量、业务无关的通用公共实体等
• util：常用实用的帮助类，如反射、字符串、集合、枚举、正则、缓存、队列等
• config：自定义的配置项，可从配置文件读取

表现层

• controller：负责页面访问控制，对外暴露Rest API接口

数据访问层

• domain：数据对象实体DO，通常和数据表、视图或其他业务对象一一对应
• dao：数据访问对象，本文demo选择比较熟悉的mybatis作为ORM工具

业务逻辑层

• service：服务 contract是接口，impl是服务实现
• entity：实体 vo是服务可对外公开的实体；dto是数据传输对象，可在服务间传递；qo：查询对象，可以认为是查询条件的封装

 

四、使用日志框架

使用Logger进行日志记录几乎不需要配置，还可以让你根据需要设置不同的日志记录级别。

Logger logger = LoggerFactory.getLogger(DemoController.class);

resources文件夹下配置logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
   <!-- 定义日志的根目录 -->
   <property name="LOG_HOME" value="D:/app/log" />
   <!-- 定义日志文件名称 -->
   <property name="appName" value="springboot-logback" />
   
   <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
   <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
       <!--
                                日志输出格式：
           %d表示日期时间，
           %thread表示线程名，
           %-5level：级别从左显示5个字符宽度
           %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
           %msg：日志消息，
           %n是换行符
       -->
       <layout class="ch.qos.logback.classic.PatternLayout">
           <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
       </layout>
   </appender>

   <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
   <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
       <!-- 指定日志文件的名称 -->
       <file>${LOG_HOME}/${appName}.log</file>
       <!--
                     当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
       TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
       -->
       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!--
                                  滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
           %i：当文件大小超过maxFileSize时，按照i进行文件滚动
           -->
           <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
           <!-- 
                                            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
                                            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
                                            那些为了归档而创建的目录也会被删除。
           -->
           <MaxHistory>365</MaxHistory>
           <!-- 
                                              当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
           -->
           <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
               <maxFileSize>100MB</maxFileSize>
           </timeBasedFileNamingAndTriggeringPolicy>
           </rollingPolicy>
             <!-- 日志输出格式： -->     
           <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
           </layout>
   </appender>

   <!-- 
       logger主要用于存放日志对象，也可以定义日志类型、级别
       name：表示匹配的logger类型前缀，也就是包的前半部分
       level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
       additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
       false：表示只用当前logger的appender-ref，true：
                     表示当前logger的appender-ref和rootLogger的appender-ref都有效
   -->
   <!-- hibernate logger -->
   <logger name="com.atguigu" level="debug" />
   <!-- Spring framework logger -->
   <logger name="org.springframework" level="debug" additivity="false" />


   <!-- 
   root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
         要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
   -->
   <root level="info">
       <appender-ref ref="stdout" />
       <appender-ref ref="appLogAppender" />
   </root>
</configuration> 

 

五、围绕Service分类

Service是Spring Boot的另一个核心，我发现最好围绕业务功能来构建服务。在应用中设计名称类似AccountService, OrderService, PersonService这样的服务，比起像DatabaseService更合适。

理想情况下controlle、Service和dao都是一对一映射，当然也可以相互调用。