SpringBoot
文章目录
一、快速启动
建立SpringBoot项目
由于本人是eclipse爱好者,这里仅介绍使用eclipse的STS插件快速创建SpringBoot项目的方法;
- 百度一下,安装好STS插件;
- 新建项目Spring Starter Project;
- 填一些信息,选一些依赖的模块,完成;
- 等待maven下载依赖;
这里贴一份不会报错的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.4.0</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo2</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo2</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
注意<maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
最好写上,不然可能会报错;
我们写一个Controller测试一下:
package com.example.demo.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
@RequestMapping("/test")
public String test() {
return "STS test";
}
}
然后直接运行根目录下的那个application.java文件,它是整个springboot项目的启动类;
就ok了;
为什么没有tomcat?
因为我们选了web模块依赖,已经内嵌了tomcat;
配置文件
项目创建好之后会有一个默认的配置文件:application.properties
;
如果我们要改内嵌tomcat的http端口的话,写入server.port=8888
即可;
但是springboot还提供了另一种方式的配置文件:yml文件;
类似这样:
server:
port: 8888
注意冒号后面必须跟空格;
二、SpringBoot整合Web
整合servlet
想要整合servlet也还是可以的,虽然感觉没啥必要了;
还是像以前那样写一个Servlet,继承HTTPServlet,重写service方法:
package com.example.demo.servlet;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(name="TestServlet",urlPatterns = "/test")
public class TestServlet extends HttpServlet{
private static final long serialVersionUID = 1L;
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.getWriter().write("<h1>Servlet in SpringBoot</h1>");
}
}
我们只要在启动类那边多加一个注解:@ServletComponentScan
,让它可以扫描servlet的注解就可以了
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
@SpringBootApplication
@ServletComponentScan
public class SpringBootWebApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootWebApplication.class, args);
}
}
整合filter
没错,我们只要想之前那样写一个filter就可以了,@ServletComponentScan
注解不仅会扫描servlet注解,也会扫描filter的注解。
package com.example.demo.filter;
import java.io.IOException;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebFilter(filterName = "TestFilter",urlPatterns = "/*")
public class TestFilter extends HttpFilter{
private static final long serialVersionUID = 1L;
@Override
public void init() throws ServletException {
// TODO Auto-generated method stub
super.init();
}
@Override
public void destroy() {
// TODO Auto-generated method stub
super.destroy();
}
@Override
protected void doFilter(HttpServletRequest req, HttpServletResponse resp, FilterChain chain)
throws IOException, ServletException {
System.out.println("start");
chain.doFilter(req, resp);
System.out.println("end");
}
}
访问静态资源
没有webcontent了,要把静态资源放哪里呢?
放在resource文件夹里面的static里即可。
注意到还有一个文件夹叫做template,它是用来放动态页面的;
但是jsp不行,因为springboot已经不推荐jsp作为动态页面了,它们推荐的是Thymeleaf;
文件上传
先写一个文件上传的页面
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>upload file</title>
</head>
<body>
<form action="fileUpload" method="post" enctype="multipart/form-data">
<input type="file" name="file" /> <br> <br> <input
type="submit" value="上传" />
</form>
</body>
</html>
写一个controller接收上传的文件
package com.example.demo.controller;
import java.io.File;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
@RestController
public class FileUploadController {
@RequestMapping("/fileUpload")
public String fileUpload(MultipartFile file) {
System.out.println(file.getOriginalFilename());
try {
String basePath = System.getProperty("user.dir") + "/src/main/resources/static/img/";
file.transferTo(new File(basePath + file.getOriginalFilename()));
} catch (Exception e) {
e.printStackTrace();
return "ERROR";
}
return "OK";
}
}
同时我们在配置文件里面要配置一下允许的文件大小和单次请求的大小,省得大文件直接报错:
server:
port: 8888
spring:
servlet:
multipart:
max-file-size: 1000MB
max-request-size: 1000MB
三、SpringBoot整合JDBC
依赖
除了web启动器之外,我们还需要在pom.xml里面加入数据库驱动和JDBC启动器以及数据源:
<!-- JDBC启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- mysql连接 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<!-- Druid 数据源 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.12</version>
</dependency>
Druid并不是必需的,SpringBoot默认提供HikariCP作为数据源;
配置
配置非常简单,yml里面按如下格式配一下就行了:
server:
port: 8888
spring:
datasource:
url: jdbc:mysql://localhost:3306/test2?useUnicode=true&characterEncoding=UTF-8&useSSL=false
driver-class-name: com.mysql.jdbc.Driver
username: root
password: *********
type: com.alibaba.druid.pool.DruidDataSource
type指定了数据源,默认的是HikariCP。
使用
结构和以前使用Jdbc是一模一样的,pojo,dao,service,controller;
假设我们要查询所有用户;
pojo:
package com.example.demo.pojo;
public class User {
private String name;
private String sex;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "User [name=" + name + ", sex=" + sex + ", age=" + age + "]";
}
}
controller:
package com.example.demo.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.example.demo.pojo.User;
import com.example.demo.service.UserService;
@RestController
public class TestJdbc {
@Autowired
private UserService userService;
@RequestMapping("/showUser")
public List<User> showUser() {
return userService.getAllUsers();
}
}
service:
package com.example.demo.service.impl;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.example.demo.dao.UserDao;
import com.example.demo.pojo.User;
import com.example.demo.service.UserService;
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserDao userDao;
@Override
public List<User> getAllUsers() {
return userDao.getAllUsers();
}
}
dao:
package com.example.demo.dao.impl;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.stereotype.Repository;
import com.example.demo.dao.UserDao;
import com.example.demo.pojo.User;
@Repository
public class UserDaoImpl implements UserDao {
@Autowired
private JdbcTemplate jdbcTemplate;
@Override
public List<User> getAllUsers() {
String sql = "select * from User";
return jdbcTemplate.query(sql, new RowMapper<User>() {
@Override
public User mapRow(ResultSet rs, int rowNum) throws SQLException {
User u = new User();
u.setAge(rs.getInt("age"));
u.setName(rs.getString("name"));
u.setSex(rs.getString("sex"));
return u;
}
});
}
}
跟以前唯一不一样的大概就是dao层了,之前我们需要自己去加载JDBC驱动,现在不这么干了。
我们直接注入JdbcTemplate,通过它来做数据库的操作。
这部分内容并不是很重要,因为我们以后肯定是要通过一些持久层框架,如Mybatis等来做数据库的交互的,所以我就不写那么细了,也没啥好写的。
四、SpringBoot整合Mybatis(重点)
依赖
我们需要添加以下的启动器:
Web、Mybatis、Jdbc、Mysql
当然如果我们要用Druid数据源的话,别忘了:
<!-- Druid 数据源 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.12</version>
</dependency>
配置
- 亲测driverClassName不写也可以;
- 另外我们需要配置将xml文件放在哪里,这里和以前不一样,要把xml放在resource下,我这里放在了resource下的mapper文件夹下;
- url中必须添加时区;
server:
port: 8888
spring:
datasource:
url: jdbc:mysql://localhost:3306/test2?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
# driver-class-name: com.mysql.jdbc.Driver
username: root
password: lijingjing
type: com.alibaba.druid.pool.DruidDataSource
mybatis:
mapper-locations: classpath:/mapper/*.xml
使用
首先我们要在启动类上面加一个注解扫描mapper包:@MapperScan("com.ljj.SpringBootMybatis.mapper")
,这样才能将Mapper注入到ioc容器中;
package com.ljj.SpringBootMybatis;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.ljj.SpringBootMybatis.mapper")
public class SpringBootMybatisApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootMybatisApplication.class, args);
}
}
之前的SSM中,我们往往是将接口和xml都放在mapper里面,现在需要分开放;
将接口还是放在原来的位置,但是将xml文件放在resource中,我这里是放在resource中的mapper文件夹下;
接口:
package com.ljj.SpringBootMybatis.mapper;
import java.util.List;
import com.ljj.SpringBootMybatis.pojo.User;
public interface UserMapper {
public List<User> getAllUsers();
}
xml:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ljj.SpringBootMybatis.mapper.UserMapper">
<select id="getAllUsers" resultType="com.ljj.SpringBootMybatis.pojo.User">
select * from user
</select>
</mapper>
剩余部分就还是老规矩,service、controller以前怎么写,现在还是怎么写,没有变化;
五、其他
热部署
只针对eclipse而言;
首先要确保project–>build automatically的勾勾是选上的;
在pom.xml里面添加依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
没错,这样就可以了。
CORS
之前SSM解决CORS问题一般都是写一个拦截器,修改请求头,然后在SpringMVC的配置文件里配一下拦截器;
在SpringBoot中可以更加方便地解决这个问题,我们写一个配置类即可:
package com.ljj.SpringBootLog.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class CORSConfigurer implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**").allowedOrigins("*").allowCredentials(true)
.allowedMethods("GET", "POST", "DELETE", "PUT").maxAge(3600);
}
}
是的,别的啥也不用干了。
日志管理
这里就不细说了,也不配置详细的日志管理的文件了,就简单试用一下;
配置文件中配一下这个:
logging:
path: log
这样的话,就会在项目根目录创建一个log文件夹,里面会有一个spring.log的文件记录日志;
如果我们要屏蔽一些包的日志输出,可以:
logging:
path: log
level:
org: off
这样就屏蔽了org包下的日志输出;
在代码里面就更简单了:
package com.ljj.SpringBootLog.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
private static Logger logger = LoggerFactory.getLogger(HelloController.class);
@RequestMapping("/test")
public String test() {
logger.info("日志输出");
return "OK";
}
}
项目打包与部署
很简单,右键run as–>maven install;
完成后target目录中会出现一个jar包,我们只要在控制台java -jar jar名称
即可运行项目;
如果我们希望程序在linux上后台运行,只要java -jar jar名称 &
即可;