目录
一、SpringBoot简介
SpringBoot是什么?
二、入门
1.创建项目
新建一个类
如何访问项目
三、SpringBoot的目录结果
下载properties与yml的文件转换插件
安装 Convert YAML and Properties File 的插件
properties转成yml文件
四、统一响应类及错误编码类
原始用法
测试:
Eolink的使用:
响应封装类
一、SpringBoot简介
SpringBoot是什么?
Spring Boot它本身并不提供Spring框架的核心特性以及扩展功能,只是用于快速、敏捷地开发新一代基于Spring框架的应用程序。
也就是说,它并不是用来替代Spring的解决方案,而是和Spring框架紧密结合用于提升Spring开发者体验的工具
同时它集成了大量常用的第三方库配置(例如Jackson, JDBC, Mongo, Redis, Mail等等),
Spring Boot应用中这些第三方库几乎可以零配置的开箱即用(out-of-the-box)
大部分的Spring Boot应用都只需要非常少量的配置代码,开发者能够更加专注于业务逻辑
注1:敏捷式开发
注2:spring boot其实不是什么新的框架,它默认配置了很多框架的使用方式, 就像maven整合了所有的jar包,spring boot整合了所有的框架
注3:基于Spring框架的一站式解决方案
二、入门
1.创建项目
#可以换源
http://start.aliyun.com
#默认勾选web、lombok、Mybatis组件
如果在旧的工作区间老是会报错的话,那就直接去file新new一个project,新建一个工作区间。
新建一个类
indexController
package com.oyang.springboot01.demo;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author oyang
* @site
* @qq 1828190940
* @create 2022-10-29 17:23
*/
//等价于@responseBody +@controller
@RestController
public class IndexController {
@RequestMapping("/")
public String index(){
System.out.println("come in");
//index字符串
return "index";
}
}
SpringBoot的运行不需要Tomcat,因为它有内置的Tomcat
如何访问项目
注意:在创建项目时,某些组件是不可随意勾选,否则是会有相应的代价,
例如勾选了mybatis:
那么,
解决方案:
1、添加数据库配置(本期暂时不涉及)
2、排除DataSource即可。
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)//排除数据源自动配置的类
三、SpringBoot的目录结果
src
main
java//java代码
resource
static//放静态资源
template
//1.模板引擎,相当于Maven项目中的webapp
//2.SpringBoot默认是不支持jsp的,官方不推荐
//application.properties//SpringBoot中唯二的配置文件
test//测试目录
application.properties
下载properties与yml的文件转换插件
安装 Convert YAML and Properties File 的插件
注:装完之后一定记得重启IDEA,否则会不生效!
properties转成yml文件
四、统一响应类及错误编码类
原始用法
bookController.java
package com.oyang.springboot01.demo;
import lombok.AllArgsConstructor;
import lombok.Data;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author oyang
* @site
* @qq 1828190940
* @create 2022-10-29 20:04
*/
@RestController
@RequestMapping("/book")
public class bookController {
@RequestMapping("/list")
public Map list(){
//查询数据库
List<Book> books = Arrays.asList(new Book(1, "西遊記"),
new Book(2, "紅樓夢"),
new Book(3, "三國演義"),
new Book(4, "水滸傳"),
new Book(5, "射雕英雄傳"));
Map map=new HashMap();
map.put("data",books);
map.put("total",122);
map.put("msg","查詢成功");
map.put("code",200);
return map;
}
@RequestMapping("/add")
public Map add(){
Map map=new HashMap();
map.put("msg","新增成功");
map.put("code",200);
return map;
}
@RequestMapping("/update")
public Map update(){
Map map=new HashMap();
map.put("msg","修改成功");
map.put("code",200);
return map;
}
@RequestMapping("/del")
public Map del(){
Map map=new HashMap();
map.put("msg","刪除成功");
map.put("code",200);
return map;
}
@RequestMapping("/load")
public Map load(){
Map map=new HashMap();
map.put("date",new Book(1,"西遊記"));
map.put("msg","查詢成功");
map.put("code",200);
return map;
}
}
@AllArgsConstructor
@Data//set/get/toString方法都不用写了
class Book{
private int id;
private String name;
}
测试:
删除
但是,一般方法的注解不是统一的
bookController:
package com.oyang.springboot01.demo;
import lombok.AllArgsConstructor;
import lombok.Data;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author oyang
* @site
* @qq 1828190940
* @create 2022-11-01 20:04
*/
@RestController
@RequestMapping("/book")
public class bookController {
@GetMapping("/list")
public Map list(){
//查询数据库
List<Book> books = Arrays.asList(new Book(1, "西遊記"),
new Book(2, "紅樓夢"),
new Book(3, "三國演義"),
new Book(4, "水滸傳"),
new Book(5, "射雕英雄傳"));
Map map=new HashMap();
map.put("data",books);
map.put("total",122);
map.put("msg","查詢成功");
map.put("code",200);
return map;
}
@PutMapping("/add")
public Map add(){
Map map=new HashMap();
map.put("msg","新增成功");
map.put("code",200);
return map;
}
@PostMapping("/update")
public Map update(){
Map map=new HashMap();
map.put("msg","修改成功");
map.put("code",200);
return map;
}
@DeleteMapping("/del")
public Map del(){
Map map=new HashMap();
map.put("msg","刪除成功");
map.put("code",200);
return map;
}
@RequestMapping("/load")
public Map load(){
Map map=new HashMap();
map.put("date",new Book(1,"西遊記"));
map.put("msg","查詢成功");
map.put("code",200);
return map;
}
}
@AllArgsConstructor
@Data//set/get/toString方法都不用写了
class Book{
private int id;
private String name;
}
注解改了之后,同样的地址却报错了
使用测试工具Eolink
Eolink的使用:
更细粒度的调测后台数据接口
再次测试删除
测试一下修改
报错了,405 是方法不匹配,将请求方式更改一下
如果需要传参该怎么办?
响应封装类
Result
package com.oyang.springboot01.result;
public class Result<T> {
//封装了一些常用的属性
private int code;//响应码
private String msg;//新增成功,修改成功等等...
//因为返回的数据不知道是什么类型,所以定义一个泛型
private T data;//向前端响应数据
private long total;//分页给值
// private CodeMsg codeMsg;
public long getTotal() {
return total;
}
public void setTotal(long total) {
this.total = total;
}
/**
* 成功的时候调用
*/
public static <T> Result<T> ok(T data) {
return new Result<T>(data);
}
public static <T> Result<T> ok(int code,String msg) {
return new Result<>(code,msg);
}
public static <T> Result<T> ok(int code,String msg,T data) {
Result<T> success = ok(data);
success.setCode(code);
success.setMsg(msg);
return success;
}
public static <T> Result<T> ok(int code,String msg,T data,long total) {
Result<T> success = ok(code,msg,data);
success.setTotal(total);
return success;
}
/**
* 失败的时候调用
*/
public static <T> Result<T> error(CodeMsg codeMsg) {
return new Result<T>(codeMsg);
}
private Result(T data) {
this.data = data;
}
private Result(int code, String msg) {
this.code = code;
this.msg = msg;
}
private Result(CodeMsg codeMsg) {
if (codeMsg != null) {
this.code = codeMsg.getCode();
this.msg = codeMsg.getMsg();
}
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
}
CodeMsg
package com.oyang.springboot01.result;
public class CodeMsg {
private int code;
private String msg;
//通用的错误码
public static CodeMsg SUCCESS = new CodeMsg(200, "success");
public static CodeMsg SERVER_ERROR = new CodeMsg(500, "服务端异常");
public static CodeMsg BIND_ERROR = new CodeMsg(500101, "参数校验异常:%s");
public static CodeMsg REQUEST_ILLEGAL = new CodeMsg(500102, "请求非法");
public static CodeMsg ACCESS_LIMIT_REACHED = new CodeMsg(500104, "访问太频繁!");
//登录模块5002XX
public static CodeMsg SESSION_ERROR = new CodeMsg(500210, "Session不存在或者已经失效");
public static CodeMsg PASSWORD_EMPTY = new CodeMsg(500211, "登录密码不能为空");
public static CodeMsg MOBILE_EMPTY = new CodeMsg(500212, "手机号不能为空");
public static CodeMsg MOBILE_ERROR = new CodeMsg(500213, "手机号格式错误");
public static CodeMsg MOBILE_NOT_EXIST = new CodeMsg(500214, "手机号不存在");
public static CodeMsg PASSWORD_ERROR = new CodeMsg(500215, "密码错误");
//商品模块5003XX
//订单模块5004XX
public static CodeMsg ORDER_NOT_EXIST = new CodeMsg(500400, "订单不存在");
//秒杀模块5005XX
public static CodeMsg MIAO_SHA_OVER = new CodeMsg(500500, "商品已经秒杀完毕");
public static CodeMsg REPEATE_MIAOSHA = new CodeMsg(500501, "不能重复秒杀");
public static CodeMsg MIAOSHA_FAIL = new CodeMsg(500502, "秒杀失败");
private CodeMsg() {
}
private CodeMsg(int code, String msg) {
this.code = code;
this.msg = msg;
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public CodeMsg fillArgs(Object... args) {
int code = this.code;
String message = String.format(this.msg, args);
return new CodeMsg(code, message);
}
@Override
public String toString() {
return "CodeMsg [code=" + code + ", msg=" + msg + "]";
}
}
bookController2
package com.oyang.springboot01.demo;
import com.oyang.springboot01.result.CodeMsg;
import com.oyang.springboot01.result.Result;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
import java.util.List;
/**
* @author oyang
* @site
* @qq 1828190940
* @create 2022-10-30
*/
@RestController
@RequestMapping("/book2")
public class bookController2 {
@GetMapping("/list")
public Result list(){
//查询数据库
List<Book> books = Arrays.asList(new Book(1, "西遊記"),
new Book(2, "紅樓夢"),
new Book(3, "三國演義"),
new Book(4, "水滸傳"),
new Book(5, "射雕英雄傳"));
return Result.ok(200,"查询成功",books,2);
}
@PutMapping("/add")
public Result add(Book book){
System.out.println(book);
if(book.getId()==0){
return Result.error(CodeMsg.BIND_ERROR.fillArgs("id未传递..."));
}
return Result.ok(200,"新增成功");
}
@PostMapping("/update")
public Result update(){
return Result.ok(200,"修改成功");
}
@DeleteMapping("/del")
public Result del(int bid){
System.out.println(bid);
return Result.ok(200,"刪除成功");
}
@RequestMapping("/load")
public Result load(){
return Result.ok(200,"加载成功",new Book(1,"西遊記"));
}
}
统一的响应封装类以及错误编码类,这个是一种良好的编码习惯!