SpringBoot + RESTFuI风格案例

于 2021-12-29 08:27:59 发布
阅读量475 收藏
点赞数
分类专栏： Spring 文章标签： spring boot spring java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WIK_7264/article/details/122197269
版权

综合案例

前言：

  • 本案例会应用到ssm、SpringBoot技术和Lombok、Swagger工具以及RESTFuI风格；并且会大概讲述一下SpringBoot、Lombok和Swagger。

一、SpringBoot

1.1 概述：

  • 什么是SpringBoot？
    • 用来简化新Spring应用的初始搭建以及开发过程 。
  • 特点：
    • 维护依赖，解决jar冲突。提供众多启动器（相当于jar包集合）
    • 简化配置，大大减少了配置文件、配置类。
    • 默认实现，默认情况下，提供了众多解决方案。

1.2 入门案例：

  • 创建maven项目
  • pom.xml文件中添加web开发启动器
  • 编写controller，基于RESTFuI风格
  • 编写启动类

1.2.1 实现

  • 创建maven项目 ： day01_springboot
  • pom.xml文件中添加web开发启动器
 <!--确定spring boot版本-->
  <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.2.5.RELEASE</version>
      <relativePath/>
  </parent>

  <dependencies>
      <!--web开发启动器-->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
  </dependencies>
  • 编写controller，基于RESTFuI风格
package com.czxy.demo01.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
* @Author: 小新
* @Date: 2021-12-16 10:35
*/
/*@Controller
@ResponseBody*/
@RestController
public class HelloController {
   @RequestMapping("/hello")
   public String hello(){
       return "hello word!";
   }
}
  • 编写启动类
package com.czxy.demo01;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Day01SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(Day01SpringbootApplication.class, args);
    }
}

二、Lombok

2.1 概述：

  • 什么是Lombok？
    • Lombok是一个简化JavaBean编写的工具。使用注解去掉了JavaBean中的getter/setter方法、toString方法、构造方法等。

2.2 使用

2.2.1 搭建环境

  • IDEA配置：shift + ctrl + alt + / 快捷键选择 Register
    shift + ctrl + alt + /
    Register
  • 安装Lombok插件
    安装Lombok插件
  • 添加坐标
<!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
  • 使用
package com.czxy.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

/**
 * @Author: 小新
 * @Date: 2021-12-28 09:53
 */
@Data  // @Setter、@Getter、@ToString
@AllArgsConstructor   //全参构造
@NoArgsConstructor   //无参构造
public class Person {
    private String userName;
    private String password;
    private String age;
    private Date birthday;
}

2.3 总结

注解描述
@Data自动生成getter、setter、toString等方法
@Setter自动生成setter方法
@Getter自动生成getter方法
@ToString自动生成toString方法
@AllArgsConstructor全参构造
@NoArgsConstructor无参构造

三、Swagger

3.1 概述：

  • 什么是Swagger？
    • API自动生成工具

3.2 使用

3.2.1搭建环境

  • 步骤 ：
    • 导入坐标
    • cope配置类
    • 特定注解
  • 实现 ：
  • 导入坐标
<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
        <swagger.version>2.7.0</swagger.version>
    </properties>

    <dependencies>

        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
    </dependencies>
  • cope配置类 :Swagger2ConfigurationV3
package com.czxy.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * Swagger2 配置类，
 * 访问路径：swagger-ui.html
 * 自动注册：
 *     位置：resources/META-INF/spring.factories
 *     内容：
 *        org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 *          com.czxy.config.Swagger2Configuration
 */
@Configuration
@EnableSwagger2
public class Swagger2ConfigurationV3 {

    @Bean
    public Docket createRestApi() {
        // 1 确定文档Swagger版本
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        // 2 设置 api基本信息
        docket.apiInfo(apiInfo());
        // 3 设置自定义加载路径
        docket = docket.select()
                .apis(RequestHandlerSelectors.basePackage("com.czxy"))
                .paths(PathSelectors.any())
                .build();
        //4 设置权限
        docket.securitySchemes(securitySchemes());
        docket.securityContexts(securityContexts());

        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API")
                .description("基于swagger接口文档")
                .contact(new Contact("xxx","联系方式"))
                .version("1.0")
                .build();
    }

    private List<ApiKey> securitySchemes() {
        List<ApiKey> list = new ArrayList<>();
        // name 为参数名  keyname是页面传值显示的 keyname， name在swagger鉴权中使用
        list.add(new ApiKey("Authorization", "Authorization", "header"));
        return list;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> list = new ArrayList<>();
        list.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("^(?!auth).*$"))
                .build());
        return list;
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> list = new ArrayList();
        list.add(new SecurityReference("Authorization", authorizationScopes));
        return list;
    }

}
  • 访问
http://localhost:8080/swagger-ui.html
  • 特定注解
注解描述
@Api修饰整个类，描述Controller的作用
@ApiOperation描述一个类的一个方法，或者说一个接口
@ApiParam单个参数描述
@ApiModel用对象来接收参数
@ApiModelPropertyr用对象接收参数时，描述对象的一个字段
@ApiResponseHTTP响应其中1个描述
@ApiResponsesHTTP响应整体描述
@ApiIgnore使用该注解忽略这个API
@ApiError发生错误返回的信息
@ApiImplicitParam一个请求参数
@ApiImplicitParams多个请求参数

四、SpringBoot + RESTFuI风格——增删改查

4.1 搭建环境

  • 创建项目：day10_springboot
  • 导入坐标
  • 拷贝Swagger 配置类
  • 编写application.yml文件
  • 编写主程序类 day10Application

4.2 实现

  • 创建项目：day10_springboot
  • 导入坐标
<!-- 1 确定spring boot的版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
    </parent>

    <!--2  确定版本-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
        <spring-cloud-release.version>Hoxton.SR3</spring-cloud-release.version>
        <nacos.version>1.1.0</nacos.version>
        <alibaba.cloud.version>2.2.1.RELEASE</alibaba.cloud.version>
        <mybatis.starter.version>1.3.2</mybatis.starter.version>
        <mapper.starter.version>2.0.2</mapper.starter.version>
        <pageHelper.starter.version>1.2.5</pageHelper.starter.version>
        <mysql.version>5.1.32</mysql.version>
        <durid.starter.version>1.1.10</durid.starter.version>
        <mybatis.plus.version>3.4.0</mybatis.plus.version>
        <swagger.version>2.7.0</swagger.version>
        <jwt.jjwt.version>0.9.0</jwt.jjwt.version>
        <jwt.joda.version>2.9.7</jwt.joda.version>
        <beanutils.version>1.9.3</beanutils.version>
    </properties>

    <!-- 3  添加依赖 -->
    <dependencies>
        <!--web开发启动器-->
        <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>
        </dependency>
        <!-- mybatis启动器 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis.starter.version}</version>
        </dependency>
        <!-- 通用Mapper启动器 -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>${mapper.starter.version}</version>
        </dependency>
        <!-- 分页助手启动器 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>${pageHelper.starter.version}</version>
        </dependency>

        <!-- mysql驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>

        <!-- Druid连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>${durid.starter.version}</version>
        </dependency>

        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
  • 拷贝Swagger 配置类
    Swagger2ConfigurationV3
  • 编写application.yml文件
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/db_20211028
    username: root
    password: 1234
    driver-class-name: com.mysql.jdbc.Driver
  • 编写主程序类 day10Application
package com.czxy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @Author: 小新
 * @Date: 2021-12-27 09:00
 */
@SpringBootApplication
public class day10Application {
    public static void main(String[] args) {
        SpringApplication.run(day10Application.class,args);
    }
}

4.3 增删改查功能

  • 步骤：
    • 编写domain （User）
    • 编写mapper （UserMapper）
    • 编写service （UserService）
    • 编写service的实现类 （UserServiceImpl）
    • 编写controller （UserController）
  • 实现
  • 编写domain （User）
package com.czxy.domain;

import org.springframework.format.annotation.DateTimeFormat;

import javax.persistence.Id;
import javax.persistence.Table;
import java.util.Date;

/**
 * @Author: 小新
 * @Date: 2021-12-28 19:54
 */
@Data
@Table(name = "user")
public class User {
    @Id
    private String uid;
    private String username;
    private String password;
    private String name;
    private String email;
    private String telephone;
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private Date birthday;
    private String sex;
    private Integer state;
    private String code;
  • 编写mapper （UserMapper）
package com.czxy.mapper;

import com.czxy.domain.User;
import tk.mybatis.mapper.common.Mapper;

/**
 * @Author: 小新
 * @Date: 2021-12-27 14:35
 */
@org.apache.ibatis.annotations.Mapper
public interface UserMapper extends Mapper<User> {
}
  • 编写service （UserService）
package com.czxy.service;

import com.czxy.domain.User;

import java.util.List;

/**
 * @Author: 小新
 * @Date: 2021-12-27 14:36
 */
public interface UserService {

    /**
     * 查询所有
     * @return
     */
    List<User> selectAll();

    /**
     * 根据id查询详情
     * @param uid
     * @return
     */
    User selectById(String uid);

    /**
     * 根据id删除
     * @param uid
     * @return
     */
    Boolean delete(String uid);

    /**
     * 更新
     * @param user
     * @return
     */
    Boolean update(User user);

    /**
     * 添加
     * @param user
     * @return
     */
    Boolean add(User user);
}
  • 编写service的实现类 （UserServiceImpl）
package com.czxy.service.impl;

import com.czxy.domain.User;
import com.czxy.mapper.UserMapper;
import com.czxy.service.UserService;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import javax.annotation.Resource;
import java.util.List;

/**
 * @Author: 小新
 * @Date: 2021-12-27 14:39
 */
@Service
@Transactional
public class UserServiceImpl implements UserService {

    @Resource
    private UserMapper userMapper;

    @Override
    public List<User> selectAll() {
        return userMapper.selectAll();
    }

    @Override
    public User selectById(String uid) {
        return userMapper.selectByPrimaryKey(uid);
    }

    @Override
    public Boolean delete(String uid) {
        int delete = userMapper.deleteByPrimaryKey(uid);
        return delete == 1 ;
    }

    @Override
    public Boolean update(User user) {
        int update = userMapper.updateByPrimaryKey(user);
        return update == 1 ;
    }

    @Override
    public Boolean add(User user) {
        int insert = userMapper.insertSelective(user);
        return insert == 1 ;
    }
}
  • 编写controller （UserController）
package com.czxy.controller;

import com.czxy.domain.User;
import com.czxy.service.UserService;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;

/**
 * @Author: 小新
 * @Date: 2021-12-27 14:46
 */
@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private UserService userService;

    /**
     * 查询所有
     * get
     * @return
     */
    @GetMapping
    public List<User> selectAll(){
        System.out.println("selectAll----success");
        return userService.selectAll();
    }

    /**
     * 根据id查询详情
     * @param uid
     * @return
     */
    @GetMapping("/{id}")
    public User selectAll(@PathVariable("id") String uid){
        System.out.println("selectById：" + uid);
        System.out.println("selectById----success");
        return userService.selectById(uid);
    }


    /**
     * 添加
     * post
     * @param user
     * @return
     */
    @PostMapping
    public String insert(@RequestBody  User user){
        System.out.println("insert----");
        Boolean result = userService.add(user);
        if (result){
            return "insert----success";
        }else{
            return "insert----error";
        }

    }


    /**
     * 更新
     * put
     * @param user
     * @return
     */
    @PutMapping
    public String update(@RequestBody  User user){
        System.out.println("更新成功：" + user);
        Boolean update = userService.update(user);
        if (update){
            return "update----success";
        }else{
            return "update----error";
        }

    }

    /**
     * 删除
     * delete
     * @param uid
     * @return
     */
    @DeleteMapping("/{id}")
    public String delete(@PathVariable("id") String uid){
        System.out.println("删除：" + uid);
        Boolean delete = userService.delete(uid);
        if (delete){
            return "delete----success";
        }else{
            return "delete----error";
        }
    }
}
  • 结果展示
    swagger
  • 查询所有
    selectAll
  • 方法都可以实现，小编就不一 一展示了，避免给各位大老爷带来视觉疲惫。
阿新-
关注
专栏目录
【SpringBoot】33、SpringBoot+LayUI后台管理系统开发脚手架
Asurplus
09-05 22万+
本期给大家推荐我自己写一个开源项目：springboot-mini，本着减少大量重复开发工作的原则，使得在项目中能够实现快速开发 1、前言 本项目本着避免重复造轮子的原则，建立一套快速开发JavaWEB项目（springboot-mini），能满足大部分后台管理系统基础开发功能，使得开发人员直接可从业务模块开始，减少大量的重复开发工作。前端框架使用 layui-mini（https://gitee.com/zhongshaofa/layuimini） 2、项目地址 https://gitee.com/asu
spring boot restful 接口示例项目
12-14
spring boot restful 接口示例项目，很详细，希望对大家有帮助。
spring boot restful服务小例子
11-06
spring boot restful服务小例子，从spring boot官网下载下来，仅用来自己学习。
Spring Boot集成Rest简单例子
NullPE3351的博客
02-04 251
@RestController public class RestTestController { @RequestMapping(value = "/rest_test/{id}") public Integer restTest(@PathVariable Integer id){ return id; } }
SpringBoot----RESTful案例
小汤圆
03-10 156
SpringBoot----RESTful案例
springboot中restfulCRUD例子
bugcat的博客
05-11 355
springboot中restfulCRUD例子 简介 在学习了springboot和web相关的内容时，学习了一下增删改查相关的讲解，所以自己也写一个增删改查的例子来记录一下,先说明为了简单本次例子中不含有数据库相关的操作，只是为了举例。 讲解 假设我们有一个学生类student需要进行展示，并且对其进行增删改查。 首先我们写一下对应的uri: 普通CRUD（uri来区分操作） RestfulCRUD 查询 getStudent student–get 添加 addStudent s
基于SpringBoot+Vue的学生选课管理系统的毕业设计，Vue+SpringBoot+MybatisPlus+MySQL
最新发布
03-24
本文主要介绍基于SpringBoot+Vue的学生选课管理系统的源码实现。该系统实现了学生选课、退课、课程管理、学生管理等功能,采用前后端分离的模式,前端使用Vue框架,后端使用SpringBoot框架。 后端使用SpringBoot+...
基于SpringBoot+MySQL+Vue的在线考试系统（源码+论文).zip
05-31
基于SpringBoot+MySQL+Vue的在线考试系统（源码+论文).zip 基于SpringBoot+MySQL+Vue的在线考试系统（源码+论文).zip 基于SpringBoot+MySQL+Vue的在线考试系统（源码+论文).zip 基于SpringBoot+MySQL+Vue的在线...
mina新手教程源码 mina+springboot+idea最简单的案例。
06-10
mina新手案例，mina新手教程源码 mina+springboot最简单的案例。用的IDEA * mina服务端 * 1、添加@Controller注解和 @PostConstruct注解，代表启动springboot项目时也调用该类下的该方法， * 启动springboot项目...
SpringBoot+SpringSecurity+JWT+MybatisPlus实现基于注解的权限验证
08-26
SpringBoot+SpringSecurity+JWT+MybatisPlus实现基于注解的权限验证，可根据注解的格式不同，做到角色权限控制，角色加资源权限控制等，粒度比较细化。 @PreAuthorize("hasAnyRole('ADMIN','USER')")：具有admin或...
spring-boot-web-restfulcrud代码示例
07-22
spring-boot-web代码示例，是IDEA的项目工程，使用restful风格实现增删查改，静态数据
SpringBoot之第一个Restfu示例
07-11 440
前面把数据库研究了差不多了。。。。今天开始研究Control层了。如何接收RestFul的Http请求。。 这里在类上面加上@RestController 这个类就可以接收rest的请求了。 但是http请求有千万种，我们如何知道哪个请求进入哪个类呢？ 这里就需要引入另外一个注解 @RequestMapping("/app") 这个注解就是说http的url中/app的进入这个分支 ...
springboot（Restful风格）
zhouhe_的博客
09-18 402
Web开发的两种方式 一 前后端不分离 以前在没有互联网时，我们做的大部分应用都是前后端不分的，比如 Jsp 或者 thymeleaf灯后端分离模版，在这种架构应用中，数据基本上都是在后端熏染好，返回给前端展示的，也就是说后端控制前端展示，耦合度很高 二 前后端分离 在前后端分离的应用模式中，后端进返回前端所需要的数据，不再渲染HTML页面，不再控制前端的效果。至于前端用户看到什么效果，从后端请求的数据如何加载到前端，都是有前端自己决定的，网页有网页的处理方式，App 有 App 的处理方式，但无论哪
SpringBoot——SpringBoot中使用RESTful风格
贝尔摩德苦艾酒
05-16 1万+
SpringBoot——SpringBoot中使用RESTful风格
Springboot 入门实例之一：创建一个RESTful Web 服务
u012995500的博客
02-19 1810
本系列文章主要记录学习 Springboot 官网快速入门实例的过程，官网的实例总共有68个，每个实例官方说大概在15~30min钟。 。我以为对于web框架的学习，先做一遍实例会比较有感觉，然后再却研究相关的图书来提高理论认知。 本文介绍快速入门实例中的第一个实例，创建一个RESTful Web 服务。当然对英文比较熟悉的话可以参照原文。 1、创建的服务 创建一个服务，接受HTTP...
SpringBoot2.0数据访问（三）整合MyBatis+RESTful风格实例
人生就是一个不断学习的过程
05-30 2744
文章来源：https://blog.csdn.net/gozhuyinglong 版权声明：本文版权归作者所有，转载请注明出处 一、引入MyBatis依赖 在pom文件中引入MyBatis依赖 &amp;amp;lt;!--引入MyBatis依赖--&amp;amp;gt; &amp;amp;...
基于SpringBoot的Restful接口开发
panlong189的博客
02-01 1639
1、SpringBoot环境搭建 ----IDE : Eclipse 文章中版本Version: Oxygen.1a Release (4.7.1a) ----JDK : jdk1.8.0_102 ----MAVEN: Eclipse已含插件不需要单独安装      1.1、Eclipse创建maven工程      File-->New-->Maven Project-->Ne
RESTful风格的springMVC
热门推荐
每天进步一点点。。。
08-08 2万+
SpringMVC实现RESTful风格 RESTful简介 1,REST架构师一个抽象的概念，目前主要是基于HTTP协议实现，其目的是为了提高系统的可伸缩性，降低应用之间的耦合度，便于框架分布式处理程序。   2,REST主要对以下两方面进行了规范 -定位资源的URL风格，例如
SpringMVC之Restful风格
脑细胞:-D的博客
11-19 156
Spring MVC对Restful风格请求支持 什么是RestfuI Restful是一种web软件架构风格，它不是标准也不是协议，它倡导的是一个资源定位及资源操作的风格。 Restful的优点 结构清晰、符合标准、易于理解、扩展方便。 RestfuI的示例 rest是一个url请求的风格，基于这种风格来请求的url，在没有rest风格的情况，原有的url设计如下： http://localhost:8080/user/queryUserByld.action?id=3 有了rest风格之后，url设计
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值