SpringBoot系列五、Http协议开发

最新推荐文章于 2024-12-07 21:05:42 发布

原创最新推荐文章于 2024-12-07 21:05:42 发布 · 712 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot

SpringBoot 专栏收录该内容

12 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中实现RESTful风格的API，包括项目搭建、依赖配置、控制器设计及各种HTTP请求处理。并通过PostMan进行实际测试。

一、创建SpringBoot项目，添加web依赖
pom文件如下：

<?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 http://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.1.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springboot.http</groupId>
    <artifactId>springboot-http</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-http</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.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>

二、创建包entity,controller,并在entity下创建User类，在controller包下创建HttpController
User类如下：

public class User {

    private String name;

    private int age;

    private Date Birthday;
    
    //get,set方法省略
}

HttpController类如下：

//RestController相当于是Controller+ResponseBody
@RestController
public class HttpController {

    private Map<String, Object> params = new HashMap<>();

    /**
     * 功能描述：测试resuful协议，从路径中获取字段
     * 测试地址 http://localhost:8080/abc/def
     * @param cityId
     * @param userId
     * @return
     */
    @RequestMapping(path = "/{city_id}/{user_id}", method = RequestMethod.GET)
    public Object findUser(@PathVariable("city_id") String cityId,
                           @PathVariable("user_id") String userId){
        params.clear();
        params.put("cityId", cityId);
        params.put("userId", userId);
        return params;
    }

    /**
     * 功能描述：测试GetMapping
     * 测试地址：localhost:8080/v1/test_get1?from=12&size=23
     * @param from
     * @param size
     * @return
     */
    @GetMapping(value = "/v1/test_get1")
    public Object testGetMapping(int from, int size){
        params.clear();
        params.put("from", from);
        params.put("size", size);
        return params;
    }

    /**
     * 功能描述：默认值，是否必须的参数
     * 测试地址：1.不传page参数：localhost:8080/v1/test_get2?size=23
     *         2.给page参数赋值：localhost:8080/v1/test_get2?size=23&page=2
     * @param from
     * @param size
     * @return
     */
    @GetMapping(value = "/v1/test_get2")
    public Object testGetMapping2(@RequestParam(defaultValue = "0", name = "page") int from, int size){
        params.clear();
        params.put("from", from);
        params.put("size", size);
        return params;
    }

    /**
     * 功能描述：bean对象传参
     * 注意：1.注意需要指定http头为content-type为application/json
     *      2.使用body传输数据
     *      3.该方法是post方式测试
     *      TODO 传输有date类型的对象，还没有找到解决方法
     * @param user
     * @return
     */
    @RequestMapping(value = "/v1/save_user")
    public Object testGetMapping3(@RequestBody User user){
        params.clear();
        params.put("user", user);
        return params;
    }

    /**
     * 功能描述：测试获取http头信息
     * 测试路径： localhost:8080/v1/get_header?id=154545
     *          在Headers中添加key为access_token的键值对
     * @param accessToken
     * @param id
     * @return
     */
    @GetMapping("/v1/get_header")
    public Object getHeader(@RequestHeader("access_token") String accessToken, String id){
        params.clear();
        params.put("access_token", accessToken);
        params.put("id", id);
        return params;
    }

    /**
     * 测试HttpServletRequest
     * 测试地址：localhost:8080/v1/test_request?id=154545
     * @param request
     * @return
     */
    @GetMapping(value = "/v1/test_request")
    public Object testRequest(HttpServletRequest request){
        params.clear();
        String id = request.getParameter("id");
        params.put("id", id);
        return params;
    }


    /**
     * 功能描述：测试PostMapping
     * @param id
     * @param pwd
     * @return
     */
    @PostMapping(value = "/v1/test_post")
    public Object testPost(String id, String pwd){
        params.clear();
        params.put("id", id);
        params.put("pwd", pwd);
        return pwd;
    }

    /**
     * 功能描述：测试PutMapping
     * @param id
     * @return
     */
    @PutMapping(value = "/v1/test_put")
    public Object testPut(String id){
        params.clear();
        params.put("id", id);
        return params;
    }

    /**
     * 功能描述：测试DeleteMapping
     * @param id
     * @return
     */
    @DeleteMapping(value = "/v1/test_del")
    public Object testDelete(String id){
        params.clear();
        params.put("id", id);
        return params;
    }
}

三、测试使用postMan工具测试
四、部分介绍
这几个注解不是SpringBoot特有的，SpringMVC中有。
@RestController=@Controller+@ResponseBody
@GetMapping = @RequestMapping(method = RequestMethod.GET)
@PostMapping = @RequestMapping(method = RequestMethod.POST)
@PutMapping = @RequestMapping(method = RequestMethod.PUT)
@DeleteMapping = @RequestMapping(method = RequestMethod.DELETE)
@RequestBody 请求体映射实体类
需要指定http头为 content-type为application/json charset=utf-8
五、遗留问题
测试传递json字符串的对象时，Date类型传值一直不对，如果有会的，麻烦请指教下。