项目实战接口开发SpringBoot

1.引入依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.3.RELEASE</version>
  </parent>
<dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
     </dependency>

2.springboot启动类

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
//启动类
@SpringBootApplication
@ComponentScan("com.test")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3.返回cookies信息的get接口开发

//@RestController加在类上面的注解，使得类里面的每个方法都将json/xml返回数据加返回到前台页面中
@RestController
public class MyGetMethod {
    //@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写
    @GetMapping("/getCookies")
    public String getCookies(HttpServletResponse response) {
         Cookie cookie = new Cookie("login","true");
         response.addCookie(cookie);
         return "恭喜你获取cookies成功";
    }
}

4.要求携带cookies信息访问的get接口开发

//要求客户端携带cookies才能访问
    @GetMapping("/getWithCookies")
    public String getWithCookies(HttpServletRequest request) {
        Cookie[] cookies = request.getCookies();
        if (cookies == null) {
            return "必须携带cookie访问";
        }
        for (Cookie c:cookies) {
            if (c.getName().equals("login")&&c.getValue().equals("true")) {
                return "恭喜你登录成功";
            }
        }
        return "必须携带cookie访问";
    }

5.携带参数的get请求两种开发方式

 /**
     * 开发一个需要携带参数才能访问的get请求。
     * 第一种实现方式 url: key=value&key=value
     * 我们来模拟获取商品列表
     * 解决参数不一致可以用@RequestParam("start")Integer s
     */
    @GetMapping("/getWithParam")
    public Map<String, Double> getWithParam(Integer start,Integer end){
        Map<String , Double> myMap = new HashMap<String, Double>();
        myMap.put("苹果", 5.5);
        myMap.put("香蕉", 2.8);
        return myMap;
    }
    /**
     * 第二种需要携带参数访问的get请求
     * url:ip:port/get/with/param/10/20
     */
    @GetMapping("/getWithParam/{start}/{end}")
    public Map<String, Double> getWithParam2(@PathVariable Integer start,@PathVariable Integer end){
        Map<String , Double> myMap = new HashMap<String, Double>();
        myMap.put("苹果", 5.5);
        myMap.put("香蕉", 2.8);
        return myMap;
    }
    

6.SpringBoot集成SwaggerUI

6.1引入依赖

<properties>
    <swagger.version>2.6.1</swagger.version>
</properties>
 <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>

6.2新建SwaggerConfig java配置类

package com.test.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.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()
                .paths(PathSelectors.regex("/.*"))
                .build();
    }

    private ApiInfo apiInfo() {
        return  new ApiInfoBuilder().title("我的接口文档")
                .description("这是我的swaggerui生成的接口文档")
                .version("1.0.0.0")
                .build();
    }
}

6.3给方法增加注解

package com.test.server;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

//@RestController加在类上面的注解，使得类里面的每个方法都将json/xml返回数据加返回到前台页面中
@RestController
@Api(value = "/",description = "这是我全部的get方法")
public class MyGetMethod {
    //@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写
    @GetMapping("/getCookies")
    @ApiOperation(value = "通过这个方法可以获取到Cookies")
    public String getCookies(HttpServletResponse response) {
         Cookie cookie = new Cookie("login","true");
         response.addCookie(cookie);
         return "恭喜你获取cookies成功";
    }
    //要求客户端携带cookies才能访问
    @GetMapping("/getWithCookies")
    @ApiOperation(value = "要求客户端携带cookies访问")
    public String getWithCookies(HttpServletRequest request) {
        Cookie[] cookies = request.getCookies();
        if (cookies == null) {
            return "必须携带cookie访问";
        }
        for (Cookie c:cookies) {
            if (c.getName().equals("login")&&c.getValue().equals("true")) {
                return "恭喜你登录成功";
            }
        }
        return "必须携带cookie访问";
    }
     /**
     * 开发一个需要携带参数才能访问的get请求。
     * 第一种实现方式 url: key=value&key=value
     * 我们来模拟获取商品列表
     * 解决参数不一致可以用@RequestParam("start")Integer s
     */
    @GetMapping("/getWithParam")
    @ApiOperation(value = "需求携带参数才能访问的get请求方法一")
    public Map<String, Double> getWithParam(Integer start,Integer end){
        Map<String , Double> myMap = new HashMap<String, Double>();
        myMap.put("苹果", 5.5);
        myMap.put("香蕉", 2.8);
        return myMap;
    }
    /**
     * 第二种需要携带参数访问的get请求
     * url:ip:port/get/with/param/10/20
     */
    @GetMapping("/getWithParam/{start}/{end}")
    @ApiOperation(value = "需求携带参数才能访问的get请求方法二")
    public Map<String, Double> getWithParam2(@PathVariable Integer start,@PathVariable Integer end){
        Map<String , Double> myMap = new HashMap<String, Double>();
        myMap.put("苹果", 5.5);
        myMap.put("香蕉", 2.8);
        return myMap;
    }
}

7.返回cookies信息的post接口开发

@RestController
@Api(value = "/",description = "这是我全部的post方法")
public class MyPostMethod {
    //这个变量是用来装我们cookies信息的
    private static Cookie cookie;
    @PostMapping("/login")
    @ApiOperation(value = "登录成功，获取cookies信息")
    public String login(@RequestParam(value = "username",required = true)String username,@RequestParam(value = "password",required = true)String password,HttpServletResponse response) {
        if (username.equals("admin")&&password.equals("admin123")) {
            cookie = new Cookie("login", "true");
            response.addCookie(cookie);
            return "登录成功";
        }
         return "用户名或者是密码错误！";
    }

}

8.Cookies验证和返回用户列表的post接口开发

8.1安装lombok插件

8.2引入lombok依赖，lombok通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.14</version>
        </dependency

8.3新建实体类

package com.test.pojo;

import lombok.Data;

@Data
public class User {
    private String username;
    private String password;
    private String name;
    private int age;
}

8.4Cookies验证和返回用户列表的post接口开发代码

 @PostMapping("/getUsersList")
    @ApiOperation(value = "获取用户列表")
    public String getUsersList(HttpServletRequest request,@RequestBody User u){
        User user;
        Cookie[] cookies = request.getCookies();
        if (cookies ==null) {
            return "参数不合法";
        }
        for(Cookie c:cookies) {
            if (c.getName().equals("login")&&c.getValue().equals("true")
                    &&u.getUsername().equals("admin")
                    &&u.getPassword().equals("admin123")) {
                user = new User();
                user.setName("李四");
                user.setAge(24);
                user.setUsername("lisi");
                user.setPassword("admin123");
                return user.toString();
            }
        }
        return "参数不合法";
    }