Salesforce Integration based on Rest API

前言

老实讲，笔者不是很会写Blog，在接下来的文章中，每篇笔者都会以 简介 - 细节 - 心得的方式去描述笔者所知道、了解的事情。笔者所写的心得，基本都是基于实际项目或者在研究过程中发现的问题、领悟来写，限于文笔，不到之处请见谅。

Rest API

Salesforce提供了Rest API，可以方便的与第三方系统进行集成。在Salesforce内，Rest API与其他的API有集成在一起的Standard API，例如：Live Agent Rest API等。这部分，笔者仅介绍一般情形下自定义的Rest API。对于一般标准Rest API，笔者将在下节详细讲述。

Rest API 支持访问方式

支持通用的Http访问形式：GET、POST、HEAD、PATCH、DELETE。

要使用Custom Rest API，首先需要创建Apex，并加入RestResource Annotation（表明是Rest Interface），如下：

@RestResource(urlMapping='/test/*')
global class CallInTest {
    //function here
}

urlMapping: 代表访问路径，格式与其他语言类似（* - 这个就不解释了）。

下面详细解释下GET和POST方式，其他方式类似就不赘述了。

为了测试方便我们在此Class内加入查询数据的静态方法 - getData，方便及时给出数据

@RestResource(urlMapping='/test/*')
global class CallInTest {
    
    global static String getData() {
        List accList = DataBase.query('SELECT id,name FROM Account limit ' + Integer.valueOf(Math.floor(Math.random() * 10 + 1)));
        return JSON.serialize(accList);
    }
}

1. GET

在上述Class内加入doGet方法，并在方法头上引用HttpGet Annotation，类似SpringMVC机制，当收到Get请求会自动转发到该方法上。

@RestResource(urlMapping='/test/*')
global class CallInTest {
    
    @HttpGet
    global static String doGet() {
        //logic here
        String str = RestContext.request.params.get('type');
        return (str == 'String' ? ('00128000008WAzNAAW') : getData());
    }
    
    global static String getData() {
        List accList = DataBase.query('SELECT id,name FROM Account limit ' + Integer.valueOf(Math.floor(Math.random() * 10 + 1)));
        return JSON.serialize(accList);
    }
}

笔者在这里解释下RestContext：RestContext封装了本次Rest会话的上下文，包括Request、Response以及各自的属性定义。笔者在这里直接return String，相当于返回type是text的Response，RestContext.request.params封装了请求的参数，可以方便的使用。

2.  POST

在上述Class内加入doPost方法，并在方法头上引用HttpPost Annotation，类似的Post请求会自动转发到该方法上。

@RestResource(urlMapping='/test/*')
global class CallInTest {
    
    @HttpGet
    global static String doGet() {
        //logic here
        String str = RestContext.request.params.get('type');
        //RestContext.response.responseBody = str == 'String' ? Blob.valueOf('00128000008WAzNAAW') : getData();
        
        return (str == 'String' ? ('00128000008WAzNAAW') : getData());
    }
    
    @HttpPost
    global static void doPost() {
        //logic here
        RestContext.response.addHeader('Content-Type', 'text/plain');
        
        RestContext.response.responseBody = Blob.valueOf(getData());
    }
    
    global static String getData() {
        List accList = DataBase.query('SELECT id,name FROM Account limit ' + Integer.valueOf(Math.floor(Math.random() * 10 + 1)));
        return JSON.serialize(accList);
    }
}

在Post方法内笔者没有直接return String，采用了标准的Response形式返回，与Get方法没有采用有一个对比。

心得

1. 事实上，在实际开发过程中，笔者很少使用直接return的形式，理由也很简单：这样的方式虽然直接，但是含糊不清，容易混淆，采用Response方式就一目了然了。而且采用Response的形式可以更加细节化的定义Response；
2. 就像我们看到的在Salesforce上搭建Rest Interface很容易也很方便，反之这样的情形下也容易出问题：随意去定义Rest，没有统一的Interface Management。很容易造成管理混乱，后期维护困难。在这里笔者做了一套Rest Framework，去管理所有的Interface，它根据不同的接口去调用不同的Handler去处理（Framework做转发和消息解析、回复），使接口架构和接口业务分离。这套Framework也会去辨别是否支持接口等。。。（好吧，笔者开始赘述了，这套Framework笔者是根据具体项目情况抽离出来的Solution，目前已在项目中使用。。。咳咳。。。不在说了）；
3. 熟悉集成的朋友知道：在实际项目中接口的数据压力不同，区别很大。在这里，笔者需要说明：Rest API不适用超大数据量，Salesforce对于超大数据量的Rest API做了升级，就是Bulk API。Bulk API是Rest API的升级版（笔者的理解），支持大批量的数据。据笔者的实际调研过程中，Rest API可以模拟Bulk API，也就是实现Bulk API的功能，但是需要更加精细的开发，相对应的对于细节的把控就会更加全面。（在一些情形下：优势和劣势是很容易发生转换的，笔者的哲学）。