SpringBoot消费BmobAPI

最新推荐文章于 2024-09-14 18:46:05 发布

weixin_34009794

最新推荐文章于 2024-09-14 18:46:05 发布

阅读量130

点赞数

文章标签： java json 开发工具

原文链接：https://juejin.im/post/5a17d6316fb9a0452a3c02fa

版权

在大部分的情况下，使用客户端开发时调用Bmob的服务是比较常见的，比如开发Android、iOS应用程序等等。这样做能够直接省去服务端开发该做的事情，一方面降低了开发成本，另一方面也提高了客户端开发的速度，对于开发人员来说真的是一树百获啊。

上面说的这些大家不要认为是在打广告或是写软文，其实纯粹就是一个普通使用者对一个产品使用后的真实感受的表达，如果你非要这样认为，就怪程序员不太会用社会语言写文章吧。好了，还是少解释，咱们坐下来开始聊代码吧。

使用到的资源

BmobRestApi文档

SpringBoot项目

本来是想从创建SpringBoot项目开始讲的，想想还是算了(主要是懒)，因为基本都是IDEA的步骤说明，都是截图，其实都不是这篇文章的重点。所以，这里就主要说明一下项目所使用的类库有哪些，项目是由maven构建的，pom.xml文件中dependencies部分具体配置如下：

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.31</version>
  </dependency>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
  </dependency>

  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>复制代码

主要是spring-boot-starter-web，因为是一个web项目所以是必须的。
其次是fastjson，主要是用于Json数据的转换处理。
另一个lombok，是我比较喜欢用的一个库，基本是每个项目必备，它能让我写代码更加简洁和方便，提高效率，这里也强烈推荐给大家，具体的使用和介绍，可以自行Google了解。

编写Config类

工程的基本结构如上图所示，在基础的SpringBoot项目上新建了DemoConfig.java、DemoController.java两个类，接下来一一介绍，首先是DemoConfig.java类。

package tech.googol.demo;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class DemoConfig {

    @Bean
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}复制代码

使用@Configuration注解标识DemoConfig类是一个配置类，SpringBoot会自动处理此标识下的相关配置，其中我们使用@Bean注解在restTemplate方法上，表示将该方法返回的RestTemplate实例交由Spring上下文管理，这样就可以在需要使用RestTemplate的地方通过@Autowired注解来调用这个实例进行使用了。

编写Controller类

下面就看看怎么在DemoController类中使用RestTemplate对象来调用BmobRestfulAPI吧。

package tech.googol.demo;

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.*;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@Slf4j
@RestController
public class DemoController {
    @Autowired
    private RestTemplate restTemplate;
    //Bmob获取服务器时间的接口地址
    String url = "https://api.bmob.cn/1/timestamp";

    @GetMapping("/time")
    public ResponseEntity getServiceTime(){
        HttpHeaders headers = new HttpHeaders();
        MediaType type = MediaType.parseMediaType("application/json; charset=UTF-8");
        headers.setContentType(type);
        headers.add("X-Bmob-Application-Id", "4b5f22926******312c2f1e027c4071e");
        headers.add("X-Bmob-REST-API-Key", "4af231ed9******bcb9ab847af29a7f4");
        HttpEntity<Object> requestEntity = new HttpEntity<Object>(headers);
        ResponseEntity<JSONObject> result = restTemplate.exchange(url, HttpMethod.GET, requestEntity, JSONObject.class);
        return result;
    }
}复制代码

这里先简单的用一个方法来调用Bmob的获取服务器时间的接口，如果能正常返回服务器时间，那么则表示调用Bmob服务接口是成功的。

@RestController注解是Spring4之后新加入的注解，它是@ResponseBody和@Controller的组合注解。因为只是为了做一个RestfulAPI项目，不是普通的Web项目，不需要做视图页面的跳转，所以直接使用@RestController，而不使用@Controller。

@Autowired注解自动装配RestTemplate对象到DemoController类中以供使用。

@GetMapping注解也是Spring4引入的一个组合注解，它是@RequestMapping(method = RequestMethod.GET)的缩写。@GetMapping("/time")表示提供一个GET请求方式的"/time"接口，该接口具体的实现在getServiceTime()方法中完成。

在这里我们在getServiceTime()方法中使用restTemplate对象调用了Bmob的获取服务器时间接口
api.bmob.cn/1/timestamp，并将接口返回的数据直接return出去,也就是作为"/time"接口的数据返回。

RestTemplate的使用

这里重点讲一下RestTemplate请求BmobApi的部分。
使用的是RestTemplate对象的exchange方法来发起一次Http请求，第一个参数是请求的接口地址，第二个参数是Http请求的方式HttpMethod.GET，第三个参数是本次请求所传入的参数，这里是将接口所需的Header参数通过添加到HttpEntity对象中进行传入的，第四个参数是本次请求response返回数据的封装格式，这里是封装成JsonObject对象进行返回。

简单封装一下

上面只是为了快速检验一下能否正常请求和响应数据，所以所有的事情都在一个方法中解决了。这也是绝大多数程序员在开发过程中经常会做的事情，为了验证一个想法是否可行，会先以简单快速的方法去实践，确认可行后再展开更加详细的架构设计。
这里我们就一步一步来，先将getServiceTime方法的实现进行拆分一下，尽量达到代码的可重用性，因为调用任何BmobRestfulAPI时，Header中都必须传递两个参数X-Bmob-Application-Id、X-Bmob-REST-API-Key,并且需要制定Content-Type为"application/json",所以我们可以先将这部分的代码单独拿出来在另一个方法中实现，暂且命名为generateRequestEntity方法,并重载一个无参的，以方便在请求BmobRestfulAPI时需要在body中传递参数和不需要传参的情形进行使用。

private HttpEntity generateRequestEntity(){
    return generateRequestEntity(null);
}

private HttpEntity generateRequestEntity(Object bodyData){
  HttpHeaders headers = new HttpHeaders();
  MediaType type = MediaType.parseMediaType("application/json; charset=UTF-8");
  headers.setContentType(type);
  headers.add("X-Bmob-Application-Id", "4b5f22926******312c2f1e027c4071e");
  headers.add("X-Bmob-REST-API-Key", "4af231ed9******bcb9ab847af29a7f4");
  HttpEntity<Object> requestEntity;
  if(null != bodyData){
      requestEntity = new HttpEntity<Object>(bodyData, headers);
  }else{
      requestEntity = new HttpEntity<Object>(headers);
  }
  return requestEntity;
}复制代码