SpringBoot的环境搭建及使用

Spring-boot

一. 第一个Spring-boot的应用

1.1 maven配置

​ 在maven文件中加入如下的依赖：

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

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

1.2 编写主配置文件

​ spring-boot的主配置文件名字按照约定叫application.yml或者application.properties，推荐使用application.yml，文件的内容如下：

server:
  port: 8080

spring:
  application:
    name: first-spring-boot

1.3 编写入口程序

@SpringBootApplication
public class FirstBootApplication {

    public static void main( String[] args ) {
        SpringApplication.run(FirstBootApplication.class, args);
    }
}

​ spring-boot的启动类上必须要加上@SpringBootApplication这个注解。

1.4 编写Controller

@RestController
@RequestMapping("first")
public class FirstController {

    @RequestMapping
    public Object print() {
        return Arrays.asList("hello", "world");
    }
}

1.5 测试

​ 启动主程序，然后在浏览器中输入：http://localhost:8080/first, 如下所示：

二. banner的设置

​ 在spring-boot应用启动的时候，会出现一个很大的“Spring”字样，那么我们如何修改呢？

​ 在resources资源文件下创建一个名为banner.txt的文件，然后在这个文件中去定义我们自己想要的内容。目前网上有很多可以定制各种字样的网站。

三. Logback

​ 日志任何一个项目都必须要存在的，它可以记录我们的很多信息 ，例如报错信息，访问信息等，方便我们进行系统的调试和数据的分析，那么我们就得选择一个好的日志框架。我们这节主要讲解Logback这个日志框架，它的执行速度上比Log4j可以快上最高10倍以上。

​ 使用Logback我们首先得定义名为logback.xml文件，文件的内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan: 当配置文件被修改后, 将会被重新载入。
	 scanPeriod: 置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
	 debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

 	<!-- 输出到控制台 -->
	<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>   
			<!-- 配置日志输出到控制台的格式 -->
      		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} -- %-4relative %-5level %logger{32} %thread -- %msg%n</pattern>  
			<charset>utf-8</charset> 
    	</encoder>
	</appender>
	
    <!-- 将日志记录到文件当中 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 基于时间和大小的的滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件输出的文件名, 必须包含%i, 从1开始-->
            <FileNamePattern>D:/logs/logback.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <!-- 最大20KB 超过最大值，会重新建一个文件-->
            <maxFileSize>20MB</maxFileSize>
            <!-- 所有的日志加起来最大的大小 -->
            <totalSizeCap>400MB</totalSizeCap>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %thread -- %msg%n</pattern>
            <charset>utf-8</charset> 
        </encoder>
    </appender>

    <!-- root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。 -->
    <root level="INFO">
        <!-- 标识这个appender将会添加到这个loger。 -->
        <appender-ref ref="stdout"/>   
        <appender-ref ref="file"/> 
    </root>

</configuration>

%d: 日期转换，花括号中指定日期的格式。

%-4relative: 该条日志输出的时间，这个时间是相对于服务器启动到打印出这条日志的相对时间，4表示时间占用的宽度。

%-5level: 日志的级别，日志总共5个级别，分别是debug,info,warn,error,fatal，从左往右日志级别越高，5表示日志级别占用的字符宽度。

%thread：该日志所属的线程。

%msg：日志信息。

%logger{32}：输出该日志信息的类，32表示包的层级。

%n: 换行。

四. yaml语法

4.1基本语法

​ k:(空格)v: 表示一对键值对，空格是必须的。

​ 以空格的缩进控制层级关系，空多少个格子没有特定的要求，只要左端对齐，都是同一级的数据。

spring:
	datasource:
		username: root
		password: 123456

4.2 值的写法

A. 字面量：普通的值（数字，字符串，布尔值)

person:
	name: zhangsan
	male: false
	age: 20

B. 数组或者集合(类似于java中的List、Set)

pets:`
	- cat
	- dog
	- pig

五. spring-boot与mybatis-plus的整合

5.1 配置依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.2</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- HikariCP数据源 -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP-java7</artifactId>
    <version>2.4.13</version>
</dependency>
<!-- mybatis分页支持 -->
<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>1.2.12</version>
</dependency>

5.2 application.yml文件的配置

server:
  port: 8082

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    url: jdbc:mysql://localhost:3306/shopping?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    #    password: Ab123456cd!!
    hikari:
      connection-test-query: select 1
      minimum-idle: 5
      maximum-pool-size: 50
    password: 123456
    
pagehelper:
  # 分页合理化设置
  reasonable: true

mybatis-plus:
  mapper-locations: classpath:/org/example/**/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

5.3 接口的编写

import com.github.pagehelper.Page;
import com.qf.pojo.MyUser;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

5.4 服务层编写

import com.github.pagehelper.PageHelper;
import com.qf.dao.MyUserMapper;
import com.qf.pojo.MyUser;
import org.springframework.stereotype.Service;
import tk.mybatis.mapper.entity.Example;
import javax.annotation.Resource;
import java.util.List;

@Service
public class UserService {

    @Resource
    private UserMapper userMapper;

    public List<MyUser> getList() {
        PageHelper.startPage(1, 2);
        Example example = new Example(MyUser.class);
        List<MyUser> list = myUserMapper.selectByExample(example);
        return list;
    }
}

附录

1.获取ip地址

public static String getIpAddress(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("HTTP_CLIENT_IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("HTTP_X_FORWARDED_FOR");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return ip;
}