springboot入门
使用课程: ①来自bilibili、 ②还是bilibili
他人笔记: [1]
一.SpringBoot概述
1.1 SpringBoot
SpringBoot提供了一 种快速使用Spring的方式,基于约定优于配置的思想,可以让开发人员不必在配置与逻辑业务之间进行思维的切换,全身心的投入到逻辑业务的代码编写中,从而大大提高了开发的效率,一 定程度上缩短了项目周期。2014年4月,Spring Boot 1.0.0发布。Spring的顶级项目之一(https://spring.io/).
1.2 Spring缺点
1)配置繁琐
虽然Spring的组件代码是轻量级的,但它的配置却是重量级的。-开始, Spring用XML配置, 而且是很多XML配置。Spring 2.5引入了基于注解的组件扫描,这消除了大量针对应用程序自身组件的显式XML配置。Spring 3.0引入了基于Java的配置,这是-种类型安全的可重构配置方式,可以代替XML。所有这些配置都代表了开发时的损耗。因为在思考Spring特性配置和解决业务问题之间需要进行思维切换,所以编写配置挤占了编写应用程序逻辑的时间。和所有框架一样, Spring实用, 但它要求的回报也不少。
2)依赖繁琐
项目的依赖管理也是一件耗时耗力的事情。 在环境搭建时,需要分析要导入哪些库的坐标,而且还需要分析导入与之有依赖关系的其他库的坐标,一旦选错了依赖的版本,随之而来的不兼容问题就会严重阻碍项目的开发进度。
1.3 SpringBoot功能
1)自动配置
Spring Boot的自动配置是一个运行时(更准确地说,是应用程序启动时)的过程,考虑了众多因素,才决定Spring配置应该用哪个,不该用哪个。该过程是SpringBoot自动完成的。
2)起步依赖
起步依赖本质上是一个Maven项目对象模型 (Project Object Model, POM),定义了对其他库的传递依赖这些东西加在一起即支持某项功能。简单的说,起步依赖就是将具备某种功能的坐标打包到一起,并提供-些默认的功能。
3)辅助功能
提供了-些大型项目中常见的非功能性特性,如嵌入式服务器、安全指标,健康检测、外部配置等。
Spring Boot并不是对Spring功能上的增强,而是提供了一种快速使用Spring 的方式。
2.SpringBoot快速入门
SpringBoot:官方文档
2.1 经典开局Hello World
需求:
搭建SpringBoot工程,定义HelloController.hello0方法, 返回”Hello World"。
实现步骤:
①创建项目
②定义Controller
③启动测试
2.1.1 新建项目
2.2.2 定义Controller控制器
在主代码目录新建一个包package,当然要是IDEA抽风就是new不了package,所谓package就是一个文件夹,去主代码文件夹目录手动新建文件夹改名字就行了,让IDEA知道,它就是一个工具,少tm抽风。
然后在Controller文件夹new一个class,当然IDEA抽风new不了class,也没有关系,反正class也不过是.java文件,new个file,用.java做后缀就好啦。让IDEA知道,它只是一个工具,少tm抽风。
controller代码:
package com.wwy.helloworld.controller;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class HelloController { //htttp://localhost:8080/hello @GetMapping("/hello") public String hello(){ return "hello world"; }}
2.2.3 启动测试
俩箭头点哪个都行
启动后,在浏览器中输入http://localhost:8080/hello
,可以看到
2.2 Spring Boot Controller
1经典开局其实就是一个web项目。
2.2.1 Web入门
■Spring Boot将传统Web开发的mvc、json、 tomcat等框架整合,提供了
spring-boot-starter-web组件,简化了Web应用配置。
■创建SpringBoot项目勾选Spring Web选项后,会自动将spring-boot-starter-
web组件加入到项目中。
■spring-boot-starter-web启动器主要包括web、webmvc、 json、 tomcat等
基础依赖组件,作用是提供Web开发场景所需的所有底层依赖。
■webmvc为Web开发的基础框架,json为JSON数据解析组件,tomcat为自带
的容器依赖。
2.2.2 mvc设计模式
model:存储封装数据
controller:协调控制数据传送
view:视图,显示数据
2.2.3 控制器
■Spring Boot提供了@Controller和@RestController两种注解来标识此类负责
接收和处理HTTP请求。
■如果请求的是页面和数据,使用@Controller注解即可;如果只是请求数据,
则可以使用@RestController注解。
@Controller的用法
■示例中返回了hello页面和name的数据,在前端页面中可以通过${name}参数
获取后台返回的数据并显示。
■@Controller通 常与Thymeleaf模板引擎擎结合使用。
这里返回的是hello.html
@Controller很少用,了解即可。
@RestController
■默认情况下,@RestController注解会将返回的对象数据转换为JSON格式。
返回的是
{ "username":"zhangsan", "password":"123"}
2.2.4 路由映射RequestMapping
①@RequestMapping注解主要负责URL的路由映射。它可以添加在Controller类或者具体的方法上。
②如果添加在Controller类上,则这个Controller中的所有路由映射都将会加上此映射规则,如果添加在方法上,则只对当前方法生效。
③@RequestMapping注解包含很多属性参数来定义HTTP的请求映射规则。常用的属性参数如下:
value:请求URL的路径,支持URL模板、正则表达式
method: HTTP请求方法consumes:请求的媒体类型(Content- Type),如application/json
produces:响应的媒体类型
params, headers: 请求的参数及请求头的值
一般写项目时也就改改value和method,其他很少改动
Value:
■@RequestMapping的value属性用于匹配URL映射, value支持简单表达式@RequestMapping(“/user”)
■@RequestMapping支 持使用通配符匹配URL,用于统一映射某些URL规则类似的请求: @RequestMapping("/getJson/*.json"),
当在浏览器中请求/getJson/a.json或者/getJson/b.json时都会匹配到后台的Json方法
@RequestMapping的通配符匹配非常简单实用,支持“*”、“?”、“**”
等通配符
■符号“*”匹配任意字符,符号“**" 匹配任意路径,符号"?”匹配单个字符。通配符的优先级低于没有通配符的,比如/user/add.json
比/user/*.json
优先匹配。
■有“**”通配符的优先级低于有"*” 通配符的。
Method:
HTTP请求Method有GET、POST、 PUT、DELETE等方式。HTTP支持的全部
Method
■@RequestMapping注解提供了method参数指定请求的Method类型,包括
RequestMethod.GET、RequestMethod.POST、 RequestMethod.DELETE、
RequestMethod.PUT等值,分别对应HTTP请求的Method
@RequestMapping(value = "/getData", method = RequestMethod.GET)public String getData(){ return "hello";}
■Method匹配也可以使用@GetMapping、@PostMapping等注解代替。
2.2.5 参数传递
■@RequestParam将请求参数绑定到控制器的方法参数上,接收的参数来自
HTTP请求体或请求url的QueryString,当请求的参数名称与Controller的业务
方法参数名称一致时, @RequestParam可以省略
■@PathVaraible:用来处理动态的URL,URL的值可以作为控制器中处理方法
的参数
■@RequestBody接收的参数是来自requestBody中,即请求体。一般用于处理
非Content Type: application/x-www-form-urlencoded
编码格式的数据,比如:‘application/json' 、application/xml
等类型的数据
一个简单的参数传递
http://localhost:8080/hello?nikename=zhangsan
@RestControllerpublic class HelloController { //http://localhost:8080/hello //http://localhost:8080/hello?nikename=zhangsan&phone=123456 //RequestMapping("/hello") @GetMapping("/hello") public String hello(String nikename,String phone){ return "hello world "+nikename+phone; }}
2.2.5.1 GET传参的几种类型
①简单传参
②服务器传过来的参数名和后台接受的变量名不一致
上面这个示例,如果前端的请求没有带变量参数,那么就会请求失败报405。如果想可以不报错可以加上required=false
2.2.5.2 POST传参的几种类型
①简单传
②传给对象
user类
package com.wwy.helloworld.entity;public class User { private String username; private String password; public void setUsername(String username){ this.username=username; } public String getUsername(){ return username; } public void setPassword(String password){ this.password=password; } public String getPassword(){ return password; }}
在前端传递过来的是json格式
③也可以限制只能使用Body传参
④通配符
2.3 静态资源访问
使用IDEA创建Spring Boot项目,会默认创建出classpath:/static/目录, 静态资源一般放在这个目录下即可。
■如果默认的静态资源过滤策略不能满足开发需求,也可以自定义静态资源过滤
策略。
在application.properties中直接定义过滤规则和静态资源位置:
spring . mvc. static-path-pattern=/static/**
spring . web. resources. static-locations=classpath:/static/
过滤规则为/static/**,静态资源位置为classpath:/static/
可以直接访问,idea默认做了静态映射
也可以设置虚拟路径限制静态资源的访问
Web程序中静态资源放在哪里,又该如何访问,默认是不加static的
2.4 文件上传
2.4.1文件上传原理
表单的enctype属性规定在发送到服务器之前应该如何对表单数据进行编码。
■当表单的enctype='”application/x-www-form-urlencoded" (默认)时,form表单中的数据格式为: key=value&key=value
■当表单的enctype= "multipart/form-data"时,其传输数据形式如下
Spring Boot工程嵌入的tomcat限制了请求的文件大小,每个文件的配置最大为1Mb
,单次请求的文件的总数不能大于10Mb
。
要更改这个默认值需要在配置文件(如application.properties)中加入两个配置
2.4.2 文件上传
当表单的enctype=" multipart/form-data"时,可以使用MultipartFile获取上传
的文件数据,再通过transferTo方法将其写入到磁盘中
@RestControllerpublic class FileController { private static final String UPLOADED_FOLDER = System.getProperty("user.dir") + "/upload/"; @PostMapping("/upload") public String upload(String nickname, MultipartFile f) throws IOException { System.out.println("文件大小" + f.getSize()); System.out.println(f.getContentType()); System.out.println(f.getOriginalFilename()); System.out.println(System.getProperty("user.dir")); saveFile(f); return "上传成功"; } private void saveFile(MultipartFile f) throws IOException { File upDir = new File(UPLOADED_FOLDER); if(!upDir.exists()) { upDir.mkdir(); } File file = new File((UPLOADED_FOLDER+f.getOriginalFilename())); f.transferTo(file); }}
新建一个controller类
完整代码:
package com.wwy.helloworld.controller;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RestController;import org.springframework.web.multipart.MultipartFile;import javax.servlet.http.HttpServletRequest;import java.io.File;import java.io.IOException;@RestControllerpublic class FileUploadController { private static final String UPLOADED_FOLDER = System.getProperty("user.dir") + "/upload/"; @PostMapping("(/upload") public String up(String nickname, MultipartFile photo, HttpServletRequest request) throws IOException{ System.out.println(nickname); //获取图片的原始名称 System.out.println(photo.getOriginalFilename()); //取文件类型 System.out.println(photo.getContentType()); System.out.println(System.getProperty("user.dir")); String path=request.getServletContext().getRealPath("/upload/"); System.out.println(path); //saveFile(photo,path); return "上传成功"; } public void saveFile(MultipartFile photo,String path) throws IOException{ File dir =new File(path); if(!dir.exists()){ dir.mkdir(); } File file=new File(path+photo.getOriginalFilename()); photo.transferTo(file); }}
2.5 拦截器
2.5.1 拦截器概念
■拦截器在Web系统中非常常见, 对于某些全局统一的操作, 我们可以把它提取
到拦截器中实现。总结起来,拦截器大致有以下几种使用场景:
■权限检查:如登录检测,进入处理程序检测是否登录,如果没有,则直接返回
登录页面。
■性能监控:有时系统在某段时间莫名其妙很慢,可以通过拦截器在进入处理程
序之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间
■通用行为: 读取cookie得到用户信息并将用户对象放入请求,从而方便后续流
程使用,还有提取Locale、Theme信息等,只要是多个处理程序都需要的,即
可使用拦截器实现。
■Spring Boot定义了HandlerInterceptor接口来实现自定义拦截器的功能
■HandlerInterceptor接口定义了preHandle、postHandle、 afterCompletion
三种方法,通过重写这三种方法实现请求前、请求后等操作
2.5.2 拦截器定义
创建一个拦截器:
public class LoginInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if(条件){ System.out.println("通过"); return true; }else{ System.out.println("不通过"); return false; } }}
2.5.3 拦截器注册
addPathPatterns方法定义拦截的地址
excludePathPatterns定义排除某些地址不被拦截
添加的一个拦截器没有addPathPattern任何一个ur则默认拦截所有请求
如果没有excludePathPatterns任何一个请求,则默认不放过任何一个请求。
@Configurationpublic class Webconfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**"); }}
2.6 RESTful
2.6.1 RESTful介绍
RESTful是目前流行的互联网软件服务架构设计风格。
■REST (Representational State Transfer,表述性状态转移)一词是由Roy Thomas Fielding在2000年的博士论文中提出的,它定义了互联网软件服务的架构原则,如果一个架构符合REST原则, 则称之为RESTful架构。
■REST并不是一个标准,它更像一组客户端和服务端交互时的架构理念和设计原
则,基于这种架构理念和设计原则的Web API更加简洁,更有层次。
RESTful API
GET PUT POST DEL ETE
2.6.2 RESTful的特点
■每一个URI代表一种资源
■客户端使用GET、POST、 PUT、 DELETE四种表示操作方式的动词对服务端资源进行操作: GET用于获取资源,POST用于新建资源(也可以用于更新资源)PUT用于更新资源,DELETE用于删除资源。
■通过操作资源的表现形式来实现服务端请求操作。
■资源的表现形式是JSON或者HTML。
■客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个请求都包含必需的信息。
2.6.3 RESTful API
符合RESTful规范的Web API需要具备如下两个关键特性:
■安全性:安全的方法被期望不会产生任何副作用,当我们使用GET操作获取资
源时,不会引|起资源本身的改变,也不会引|起服务器状态的改变。
■幂等性:幂等的方法保证了重复进行一个请求和一-次请求的效果相同(并不是
指响应总是相同的,而是指服务器上资源的状态从第一-次请求后就不再改变
了),在数学上幂等性是指N次变换和一次变换相同。
2.6.4 HTTP Method
■HTTP提供了POST、GET、PUT、DELETE等操作类型对某个Web资源进行
Create、Read、 Update和Delete操作。
■一个HTTP请求除了利用URI标志目标资源之外,还需要通过HTTP Method指
定针对该资源的操作类型,一些常见的HTTP方法及其在RESTful风格下的使用:
2.6.5 HTTP状态码
■HTTP状态码就是服务向用户返回的状态码和提示信息,客户端的每- -次请求,
服务都必须给出回应,回应包括HTTP状态码和数据两部分。
■HTTP定义了 40个标准状态码,可用于传达客户端请求的结果。状态码分为以下
5个类别:
■1xx:信息,通信传输协议级信息
■2xx:成功,表示客户端的请求已成功接受
■3xx:重定向,表示客户端必须执行一-些其他操作才能完成其请求
■4x:客户端错误,此类错误状态码指向客户端
■5xx:服务器错误,服务器负责这写错误状态码
■RESTful API中使用HTTP状态码来表示请求执行结果的状态,适用于REST API
设计的代码以及对应的HTTP方法。
2.6.6 Spring Boo实现RESTful API
■Spring Boot提供的spring-boot-starter-web组件完全支持开发RESTful API,提供了与REST操作方式(GET、POST、 PUT、DELETE) 对应的注解。
■@GetMapping: 处理GET请求, 获取资源。
■@PostMapping: 处理POST请求,新增资源。
■@PutMapping:处理PUT请求,更新资源。
■@DeleteMapping:处理DELETE请求,删除资源。
■@PatchMapping:处理PATCH请求,用于部分更新资源。
■在RESTful架构中,每个网址代表-种资源, 所以URI中建议不要包含动词,只
包含名词即可,而且所用的名词往往与数据库的表格名对应。
用户管理模块API示例:
2.7 Swagger
来源地址:https://blog.csdn.net/Cream_Cicilian/article/details/132531418