4.1 -Springboot 编写http接口

最新推荐文章于 2023-12-11 18:57:35 发布
最新推荐文章于 2023-12-11 18:57:35 发布
阅读量6.3k 收藏 38
点赞数 3
分类专栏： 开发-测试技术基础知识培训
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lovelyruiju/article/details/114830720
版权

Springboot 编写http接口

回到第一章：目录

文章目录

前言


基于 springboot 框架，快速的编写http接口。
1、前后台不分离模式，get和post请求接口的编写方法。
2、无前台，仅后台系统间交互的get和post请求接口编写方法。
3、前后台分离，restful风格的http接口编写方法

提示：以下是本篇文章正文内容，下面案例可供参考

新建一个springboot工程

1、在resources目录下创建配置文件：

application.yml
server:
  port: 9001
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://192.168.119.1:3306/devops_play?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
    username: root
    password: MySql@0004
  thymeleaf:
    prefix: classpath:/templates/
    check-template-location: true
    suffix: .html
    encoding: UTF-8
    content-type: text/html
    mode: HTML5
    cache: false
  devtools:
      restart:
        enabled: true

2、pom文件增加

<properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--SpringBoot热部署配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

3、工程目录结构
在这里插入图片描述
4、MainApp启动类和User实体类

MainApp.java

package com;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan("com.controller")
@EntityScan("com.entity")
public class MainApp {
    public static void main(String[] args) {
        SpringApplication.run(MainApp.class, args);
    }
}

User.java

package com.entity;

import java.util.Date;
import java.util.Objects;

public class User {
    /**id 自增主键*/
    private Long id;
    private String userName;
    /**用户姓名*/
    private String realName;
    /**用户登录密码*/
    private String password;
    /**用户性别：1-男；2=女*/
    private int sex;
    /**用户邮箱*/
    private String email;
    /**手机号*/
    private String mobile;
    /**创建时间*/
    private Date createDate;
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", realName='" + realName + '\'' +
                ", password='" + password + '\'' +
                ", sex=" + sex +
                ", email='" + email + '\'' +
                ", mobile='" + mobile + '\'' +
                ", createDate=" + createDate +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return sex == user.sex && Objects.equals(userName, user.userName) && Objects.equals(realName, user.realName) && Objects.equals(password, user.password) && Objects.equals(email, user.email) && Objects.equals(mobile, user.mobile);
    }

    @Override
    public int hashCode() {
        return Objects.hash(userName, realName, password, sex, email, mobile);
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getRealName() {
        return realName;
    }

    public void setRealName(String realName) {
        this.realName = realName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public int getSex() {
        return sex;
    }

    public void setSex(int sex) {
        this.sex = sex;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getMobile() {
        return mobile;
    }

    public void setMobile(String mobile) {
        this.mobile = mobile;
    }

    public Date getCreateDate() {
        return createDate;
    }

    public void setCreateDate(Date createDate) {
        this.createDate = createDate;
    }
}

一、前后台不分离模式，get和post请求接口的编写方法。

1、 编写 html页面和样式文件css
新建index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<!-- html的头部-->
<head>
    <title>用户管理演示</title><!-- 网页标题-->
    <meta charset="utf-8"><!-- 编码格式-->
    <link rel="stylesheet" type="text/css" href="/css/my.css"><!-- 引入样式文件-->
</head>
<!-- html的body部分-->
<body>
<div id="main-container" >  <!-- 最外层div区域-->
    <div id="div-header" >  <!-- 用于显示头部的div区域-->
        <h3 style="margin-bottom:0;">用户管理</h3>
        </hr>
    </div>
    <div id="div-content" >
        </br>
        <hr>
        <button class="buttonUser" id="addUserButton" onclick="addUser()">添加用户</button><br/><br/>
        <button class="buttonUser" id="searchUserButton" onclick="searchUser()">查询用户</button> <br/><br/>
        <button class="buttonUser" id="delUserButton" onclick="delUser()">删除用户</button>
        <br><br><br><br>
        <p>当前版本V1.0</p>
    </div>
</div>

<script type="text/javascript">
//点击按钮跳转到登录页面
function addUser()
{
    alert("你点击了添加用户按钮。");
}
function searchUser()
{
    alert("你点击了查询用户按钮。");
}
function delUser()
{
    alert("你点击了删除用户按钮。");
}
</script>
</body>
</html>

新建样式文件my.css

/*所有的 p 标签的样式*/
p {
    color:black;
}

/**最外层区域的样式*/


#main-container
{
    position:absolute;/**采用绝对布局*/
    width:100%;/**宽度填满浏览器*/
    height:100%;/**高度填满浏览器*/
    background-color:#D0D0D0/**设置背景色为灰色*/
}
/** 头部 区域的样式*/
#div-header
{
    text-align:center;/** 区域元素居中显示*/
    color:red;/** 设置字体颜色为红色 */
    position:relative;/**采用相对布局*/
    height:80px;/** 高度 80像素*/
    width:800px; /** 宽度 800像素*/
    margin-left:50px; /** 距离左边的边距 50像素*/
}
/** 内容 区域的样式*/
#div-content
{
    text-align:center;/** 该div区域的所有文本居中显示*/
    position:absolute;/**采用相对布局*/
    background-color:#D0D0D9; /**设置背景色为灰色*/
    height:600px;/** 高度 600像素*/
    width:800px;/** 宽度 800像素*/
    border:2px dashed; /** 边框的像素 2， dashed 含义为 虚线框*/
    border-color:gray; /** 边框颜色为灰色*/
    box-shadow: 2px 2px 5px #D0D0D9; /** 边框阴影效果*/
    margin-top:20px; /** 上边距20 像素*/
    margin-bottom:10px; /** 下边距10 像素*/
    margin-right:50px; /** 右边距50 像素*/
    margin-left:50px; /** 左边距50 像素*/
    border-radius:25px; /** 边框的圆角像素 25像素*/

}

2、新建UserController对象，编写http接口

package com.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Controller  表明这个是controller，提供http访问能力。
 * @RequestMapping("/") 表示要访问这个controller类里的方法的根路径，
 */
@Controller
@RequestMapping("/")
public class UserController {

    /**
     *  GET  POST 请求均可以接收到;
     *  返回的是一个 index.html页面
     *  传入的参数name，可以在 url地址后面，也可以在body里
     *  @RequestMapping("/index") 和 类名上的 @RequestMapping("/") 拼接起来，访问路劲为 /index
     *  RequestMapping 支持http所有的请求方式，如get，post，put，delete等
     * @param name
     * @return
     */
    @RequestMapping("/index")
    public String index(String name) {
        System.out.println("/index 接受到的参数为：" + name);
        return "index.html";
    }

    /**
     *  仅支持 GET 请求方式
     *  返回的是一个 index.html页面
     *  传入的参数name，可以在 url地址后面，也可以在body里
     *  GetMapping 只支持get类请求
     * @param name
     * @return
     */
    @GetMapping("/getIndex")
    public String index2(String name) {
        System.out.println("/getIndex 接受到的参数为：" + name);
        return "index.html";
    }

    /**
     *  仅支持 POST 请求方式
     *  返回的是一个 index.html页面
     *  传入的参数name，可以在 url地址后面，也可以在body里  form-data  x-www-form-urlencoded 格式均可
     PostMapping 只支持 post 类请求
     * @param name
     * @return
     */
    @PostMapping("/postIndex")
    public String index3(String name) {
        System.out.println("/postIndex 接受到的参数为：" + name);
        return "index.html";
    }

    /**
     *  仅支持 POST 请求方式
     *  返回的是一个 index.html页面
     *  传入的参数name，必须在请求的body里，x-www-form-urlencoded 格式或json格式
     * @param name
     * @return
     */
    @PostMapping("/postIndex2")
    public String index4(@RequestBody String name) {
        System.out.println("/postIndex 接受到的参数为：" + name);
        return "index.html";
    }
}

二、无前台，仅后台系统间交互的get和post请求接口编写方法

1、编写UserController2对象，内容为：

package com.controller;

import com.entity.User;
import org.springframework.web.bind.annotation.*;

/**
 * RestController 注解，表示这是一个restful风格的http接口对象。
 * 返回的内容为字符串，而不是一个html页面的名字。
 * 返回的字符串，可以是数字，任意格式字符。比如json格式，xml格式，及其他自定义格式等。
 */
@RestController
@RequestMapping("/user")
public class UserController2 {

    /** 新增用户 接口
     *  请求路径：/user/addJson
     *  请求方法：post
     *  参数：User对象的json格式，如：
     * {"userName":"zhc2","realName":"xxt","password":"123456","sex":"1","email":"asdf@devmail.com","mobile":"19524585455","createDate":"Sat Jan 23 16:26:01 CST 2021"}
     RequestBody 表示这个post请求，必须有请求体。
     * */
    @PostMapping("/addJson")
    public String addUser(@RequestBody User user){
      System.out.println("/user/addJson 收到的参数为："+user.toString());
      return "/user/addJson 收到的参数为："+user.toString();
    }

    /** 新增用户 接口
     *  请求路径：/user/addForm
     *  请求方法：post
     *  参数：User对象参数所需要的key-value的格式，如：
     * userName=zhc2
     * realName=xxt
     * password=123456
     * sex=1
     * email=asdf@devmail.com
     * mobile=19524585455
     * createDate=Sat Jan 23 16:26:01 CST 2021
     * */
    @PostMapping("/addForm")
    public String addUser2(User user){
        System.out.println("/user/addForm 收到的参数为："+user.toString());
        return "/user/addForm 收到的参数为："+user.toString();
    }

    /** 新增用户 接口
     *  请求路径：/user/addGet?userName=zhc2&realName=xxt&password=123456&sex=1&email=asdf@devmail.com&mobile=19524585455&createDate=Sat Jan 23 16:26:01 CST 2021
     *  请求方法：get
     * */
    @GetMapping("/addGet")
    public String addUser3(User user){
        System.out.println("/user/addForm 收到的参数为："+user.toString());
        return "/user/addForm 收到的参数为："+user.toString();
    }

    /**根据id查询用户*/
    @GetMapping("/get")
    public String getUser(Long id){
        System.out.println("/user/get 收到的参数为："+id);
        return "/user/get 收到的参数为："+id;
    }

}

三、前后台分离，restful风格的http接口编写方法

restful风格 一般要求请求和返回必须用json格式字符进行交互，但不是必须的。

1、新增RestFulController对象，内容为：
package com.controller;

import org.springframework.web.bind.annotation.*;

/**
 * Restful风格 规范了http请求的方式，这是一种约定的写法，最明显就是：
 * 新增用put请求方式
 * 删除用delete请求方式
 * 修改用post请求方式
 * 查询用get请求方式
 */
@RestController
@RequestMapping("/user")
public class RestFulController {

    /**
     * 增
     * @param name
     * @return
     */
    @PutMapping("/add")
    public String add(String name){
        System.out.println("add 请求参数为："+name);
        return "add 请求参数为："+name;
    }

    /**
     *  删
     * @param name
     * @return
     */
    @DeleteMapping("/del")
    public String del(String name){
        System.out.println("del 请求参数为："+name);
        return "del 请求参数为："+name;
    }

    /**
     *  改
     * @param name
     * @return
     */
    @PostMapping("/update")
    public String update(String name){
        System.out.println("del 请求参数为："+name);
        return "del 请求参数为："+name;
    }

    /**
     *  查
     * @param name
     * @return
     */
    @GetMapping("/list")
    public String list(String name){
        System.out.println("list 请求参数为："+name);
        return "list 请求参数为："+name;
    }

    /**
     *  查 1 个
     *  {id}  配合 @PathVariable 是路径参数的写法，大多用来根据id查询某个数据
     *  访问路径如 ：/list/1  ,/list/2 等，
     * @param id
     * @return
     */
    @GetMapping("/list/{id}")
    public String listById(@PathVariable Long id){
        System.out.println("listById 请求参数为："+id);
        return "listById 请求参数为："+id;
    }

}

四 、使用postman测试以上接口

1、前后台不分离

请求方式get
参数可以填在url后面
也可以填在form-data里
在这里插入图片描述

2、仅有后台的http接口

在这里插入图片描述
必须有body的接口
在这里插入图片描述

3、restful风格接口

在这里插入图片描述
put 必须有body
在这里插入图片描述
删除用delete
在这里插入图片描述
修改用post
在这里插入图片描述

如沐春风细雨中
关注
  • 3
    点赞
  • 踩
  • 38
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
gradle-4.1-all压缩资源包系列.zip
08-08
使用说明 1，官网下载地址https\://services.gradle.org/distributions/gradle-3.3-all,不同版本更改版本号即可，官网下载不成功的，嫌官网下载速度慢的，可以直接在这里下载 2，更多版本gradle*.zip资源包参见https://editor.csdn.net/md/?articleId=107882711，如有需要可当做工具收藏。这里坚持并且免积分下载，如有需要积分可以博客下留言邮箱
spring boot中使用http请求的示例代码
08-28
本篇文章主要介绍了spring boot中 使用http请求的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
我的gradle-4.1-all.zip
10-31
就简单的2分吧，我看其他的都很贵，自己下载了，使用 就简单的2分吧，我看其他的都很贵，自己下载了，使用
【官方绿色版】gradle-4.1-rc-1-all.zip
11-08
Gradle各个版本即将上线，官网下载不成功的，嫌官网下载速度慢的，可以直接在这里下载。本人会做一个gradle全版本的搜集。 gradle-4.1 gradle android studio 离线包
vray4.1-for-SketchUp2016-2019高质量渲染软件.rar
07-10
VRay是一款高质量渲染软件，基于V-Ray 内核开发的有VRay for 3ds max、Maya、Sketchup、Rhino等诸多版本，为不同领域的优秀3D建模软件提供了高质量的图片和动画渲染，方便使用者渲染各种图片。VRay将向智能化，多元化方向发展，VRay后期发展云计算是未来主导方向。
【SpringBoot】7 种实现 HTTP 调用的方式
sco5282的博客
06-21 7012
作者在工作中，遇到一些需要调用三方接口的任务，就需要用到 HTTP 调用工具。
SpringBoot HTTP接口实战-基础篇
Trazen的专栏
08-26 409
作用于形参列表上，用于将前台发送过来固定格式的数据【xml 格式或者 json等】封装为对应的 JavaBean 对象，封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析，然后封装到形参上。使用在控制层（controller）的方法上，将方法的返回值，以特定的格式写入到response的body区域，进而将数据返回给客户端。作用于类或者方法上，用于映射URL路径，将http的请求地址映射到控制器(controller)类的处理方法上。用于定义控制器类，注解是。...
Springboot -- 用更优雅的方式发HTTP请求(RestTemplate详解)
BASK2312的博客
12-27 6987
是Spring提供的用于访问Rest服务的客户端，提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。我之前的HTTP开发是用apache的HttpClient开发，代码复杂，还得操心资源回收等。代码很复杂，冗余代码多，稍微截个图，这是我封装好的一个post请求工具：本教程将带领大家实现Spring生态内RestTemplate的Get请求和Post请求还有的实践和核心方法源码的分析，看完你就会用优雅的方式来发HTTP请求。
【SpringBoot教程】SpringBoot开发HTTP接口GET请求实战
大数据小禅的博客
03-25 6034
本专栏为SpringBoot+Spring+Mybatis的系列零基础教程，从框架的基础知识讲起，从0开始实现一个在线教育实战项目🚀。
基于Spring Boot使用Java调用http请求的6种方式
热门推荐
zhangbeizhen18的博客
07-20 1万+
记录：287 场景：基于Spring Boot使用Java调用http请求的6种方式。服务端发布一个POST请求和2个GET请求。使用6种方式实现的客户端都调用服务端发布的这3个方法。可以直观感受和比对6种http请求的客户端。......
gradle-4.1-all.zip,第二部分
10-12
官网下载不成功的，或者嫌官网下载速度慢的，可以直接在这里下载。 这是gradle-4.1-all.zip压缩包的第二部分，总共有2个部分。第一部分是收费的。 请把两个压缩包放到同一个文件夹下，任选一个压缩包解压后即为全部gradle-4.1的code。
SpringBoot调用HTTP接口
hello，word！
11-23 829
Data// 响应状态// 响应描述// 响应体​// 调用 execute 时自定义 响应处理类});
Spring Boot（一）之请求接口示例
Widsom的博客
08-18 8352
Spring Boot（一）之请求接口示例 1. 创建一个Spring Boot的web程序 1.1 创建一个Project 选择Spring Initializr，点击Next。 1.2 编辑Project Metadata，如图： 修改Group，Artifact，点击Next 1.3 选择Web程序 点击Next 1.4 选择项目的目录 点击Finish...
SpringBoot项目调用HTTP接口5种方式你了解多少？
风水道人
12-11 1363
1. 使用FeignClient调用：Feign是一个声明式的Web Service客户端，它使得编写HTTP客户端变得更简单。通过FeignClient，你可以在代码中直接调用HTTP接口，而不需要手动编写HTTP请求和响应的处理逻辑。2. 使用RestTemplate调用：RestTemplate是Spring框架提供的用于访问RESTful服务的工具类。它提供了多种HTTP请求方法（如GET、POST、PUT、DELETE等），并支持自定义HTTP消息转换器以处理HTTP请求和响应。
springbootHttp接口
奇点
02-13 1124
请求注解： @RestController and @RequestMapping是springMVC的注解，不是springboot特有的 @RestController = @Controller+@ResponseBody （Json格式）不加的话会当成一个页面view 会出错 @SpringBootApplication = @Configuration+@Ena...
spring boot请求http接口的三种方式
YUHUIXIAOFEI的博客
04-19 3282
OpenFeign是SpringCloud自己研发的，在Feign的基础上支持了Spring MVC的注解，如@RequesMapping等等。OkHttp 是一个第三方的 HTTP 客户端库,它比 Java 标准的 HttpURLConnection 更高效、更实用。HttpURLConnection主要工作内容：打开socket连接，封装http请求报文，解析请求报文。HttpURLConnection 是 Java 中的 HTTP 客户端实现，,适用于简单的请求需要。定义FeignClient。
SpringBoot、HTTP协议
2301_78107465的博客
05-30 859
SpringBoot、HTTP协议
springboot基础框架搭建
weixin_45699919的博客
06-06 5881
牢靠的地基，才能筑起高楼
基础篇-SpringBoot HTTP接口实战
Huangjiazhen711的博客
09-06 889
作用于形参列表上，用于将前台发送过来固定格式的数据【xml 格式或者 json等】封装为对应的 JavaBean 对象，封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析，然后封装到形参上。如果是一个对象，会将对象转化为json串，然后写到客户端。用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。设置默认值后，不传参会使用默认值。
package redhat-lsb-4.1-47.el8.x86_64 requires redhat-lsb-languages = 4.1-47.
最新发布
12-22
这个问题是关于Redhat LSB 软件包的依赖性的问题。错误信息显示，redhat-lsb-4.1-47.el8.x86_64这个软件包需要redhat-lsb-languages版本为4.1-47。这意味着当你尝试安装redhat-lsb-4.1-47.el8.x86_64软件包时，系统会检查并要求安装redhat-lsb-languages版本为4.1-47。 要解决这个问题，首先应该确认你的软件包管理器是否已经安装了redhat-lsb-languages软件包，并且版本号是4.1-47。如果已经安装了该软件包但版本号不匹配，你可以尝试升级或降级redhat-lsb-languages软件包的版本以满足依赖性要求。如果你还没有安装redhat-lsb-languages软件包，你需要先安装该软件包并确保版本号是4.1-47。 另外，你还可以尝试在软件包管理器中搜索是否有新的redhat-lsb-4.1-47.el8.x86_64软件包的更新版本。有时候更新版本的软件包可能已经修复了依赖性方面的问题。 总之，解决这个问题的关键是确认并满足redhat-lsb-4.1-47.el8.x86_64对redhat-lsb-languages软件包版本的依赖性要求。如果你需要进一步的帮助，可以查阅Redhat官方文档或者寻求社区支持。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值