调用方法

• 云函数是一段部署在服务端的代码片段，采用 java 或 node.js 进行编写，然后部署运行在Bmob服务器
• 通过云函数可以解决很多复杂的业务逻辑，从此无需将要将大量的数据发送到移动设备上做计算处理
• 只需将这些计算都交由服务端运算处理，最后移动客户端仅仅需要接收云函数运算处理返回的数据结果就可以了
• 通过更新云函数代码片段，客户端无需更新，便满足业务改动的需求。这样云函数便有更多的灵活性和自主性

调用方法

云函数提供了以下几种方式提供调用：

Android SDK

iOS SDK

C# SDK

Restful api

Http请求

日志

• 可在Bmob后台根据时间、日志级别、内容关键字、方法名搜索想要的日志
• 每个应用拥有最大10m的日志空间，循环写入
• 高级用户有实时日志功能

代码规范

• java云函数必须遵循以下格式：

    public static void onRequest(final Request request, final Response response, final Modules modules) throws Throwable {
    // 上面这个方法体，不允许任何修改
    // 这里使用Java编写云函数
    // 最后一个字符必须是 }
    }

• 代码不能包含以下关键字：(保存代码时有错误提醒)

    Class
    File
    System
    ...

• 需要获取当前毫秒时，可用 getTime() 、new java.util.Date().getTime() 替代 System.currentTimeMillis()
• 如果确实需要用到被禁止使用的关键字，例如查询”File”表，可用”F”+”ile”的形式拼接
• 不可包含/**/注释，如需注释，请用 //
• 仅可写一个Java的方法，不能写多个方法、类变量、静态变量等
• 云函数执行完毕后，必须用response.send方法返回响应数据，否则会被当做超时，多次超时可能会被暂停使用

Request对象

onRequest方法参数中 Request request 包含了本次请求的全部信息：

Response对象

• onRequest方法参数中 Response response 用于响应请求，返回数据
• Response对象仅有名为 send 的方法，参数不同共有4种重载形式(Overloading):

1. send(Object res)
2. send(Object res, int statusCode)
3. send(Object res, int statusCode, String statusMsg)
4. send(Object res, int statusCode, String statusMsg, JSONObject headers)

以下是参数说明：

• 示例

    // 1. 直接返回字符串
    response.send("Hello world--Bmob");
    // 2. 返回404错误
    response.send("Error", 404, "NotFound");
    // 3. 返回中文字符串，需要返回包含charset的header
    response.send(
        "你好，比目",
        200,
        "OK",
        JSON.toJson("Content-Type", "text/plain; charset=UTF-8")
    );

Modules对象

• onRequest方法参数中 Modules modules 提供了几个模块供开发者调用：

日志输出

    // 设置需要输出的日志级别
    // Level_All = 0
    // Level_Debug = 1
    // Level_Warn = 2
    // Level_Error = 3
    modules.oLog.level = modules.oLog.Level_All // 全部都会输出
    modules.oLog.level = modules.oLog.Level_Warn // 仅输出Warn和Error
    modules.oLog.level = modules.oLog.Level_Error // 仅Error级别日志
    modules.oLog.d(Object) // 输出Debug级别日志
    modules.oLog.w(Object) // 输出Warn级别日志
    modules.oLog.e(Object) // 输出Error级别日志
    modules.oLog.debug(String,Object...) // 格式化输出Debug级别日志
    modules.oLog.warn(String,Object...) // 格式化输出Warn级别日志
    modules.oLog.error(String,Object...) // 格式化输出Error级别日志

Bmob数据操作

以下均为 modules.oData 的方法：

内置类

HttpResponse

类变量:

ResponseStatus

类变量:

Querier

类方法:

BmobUpdater

该类的全部静态方法都用于设置insert、update方法的请求内容

静态方法：

JSON

静态方法：

    String stringify(JSONObject m)
    String stringify(JSONArray m)
    JSONObject parse(String s)
    JSONArray parseArray(String s)
    JSONObject setJson(JSONObject json, Object... kNvs)
    JSONArray append(JSONArray array, Object... objs)
    JSONArray toArray(Object... objs)
    JSONObject strsToJson(String... kNvs)
    JSONObject toJson(Object... kNvs)

JSONObject

类方法：

    int size()
    boolean isEmpty()
    boolean containsKey(Object key)
    boolean containsValue(Object value)
    Object get(Object key)
    Object put(String key, Object value) 
    Object remove(Object key)
    void clear()
    Set<String> keySet()
    BigInteger getBigInteger(String key)
    BigDecimal getBigDecimal(String key)
    Boolean getBoolean(String key)
    boolean getBooleanValue(String key)    
    Byte getByte(String key)
    byte getByteValue(String key)
    Date getDate(String key)
    Double getDouble(String key)
    double getDoubleValue(String key)
    Float getFloat(String key)
    float getFloatValue(String key)
    Integer getInteger(String key)
    int getIntValue(String key)
    JSONArray getJSONArray(String key)
    JSONObject getJSONObject(String key)
    Long getLong(String key)
    long getLongValue(String key)
    Short getShort(String key)
    short getShortValue(String key)
    String getString(String key)

JSONArray

类方法：

    int size() 
    boolean isEmpty() 
    boolean contains(Object o) 
    boolean add(Object e) 
    boolean remove(Object o) 
    boolean containsAll(Collection<?> c) 
    boolean addAll(Collection<? extends Object> c) 
    boolean addAll(int index, Collection<? extends Object> c) 
    boolean removeAll(Collection<?> c) 
    boolean retainAll(Collection<?> c) 
    void clear() 
    Object get(int index) 
    Object set(int index, Object element) 
    void add(int index, Object element) 
    Object remove(int index) 
    BigInteger getBigInteger(int index) 
    BigDecimal getBigDecimal(int index) 
    Boolean getBoolean(int index) 
    boolean getBooleanValue(int index) 
    Byte getByte(int index) 
    byte getByteValue(int index) 
    Date getDate(int index) 
    Double getDouble(int index) 
    double getDoubleValue(int index) 
    Float getFloat(int index) 
    float getFloatValue(int index) 
    Integer getInteger(int index) 
    int getIntValue(int index) 
    JSONArray getJSONArray(int index) 
    JSONObject getJSONObject(int index) 
    Long getLong(int index) 
    long getLongValue(int index) 
    Short getShort(int index) 
    short getShortValue(int index) 
    String getString(int index)

BmobPointer

构造方法：

    BmobPointer(String className, String objectId)

Bmobfile

构造方法：

    Bmobfile(String filename, String url)

BmobDate

构造方法：

    BmobDate(String timeStamp)
    BmobDate(long millSec)

BmobGeoPoint

构造方法：

    BmobGeoPoint(double longitude, double latitude)

AES

静态方法：

    byte[] aes(byte[] str, byte[] key, byte[] iv, boolean eOd, String keyAlgorithm, String cipherAlgorithm)
    byte[] Encode(byte[] content, byte[] key, byte[] iv)
    byte[] Decode(byte[] content, byte[] key, byte[] iv)

Base64

静态方法：

    String Encode(byte[] data)
    byte[] Decode(String str)

Crypto

静态方法：

    String Encode(String algorithm, String content)
    String Encode(String algorithm, byte[] bytes)
    byte[] EncodeToBytes(String algorithm, byte[] bytes)
    String Bytes2Hex(byte bytes[])
    String Bytes2Hex(byte bytes[], int offset, int length)

GZip

静态方法：

    byte[] Decode(byte[] bytes)
    byte[] Encode(byte[] bytes)

MD5

静态方法：

    String Encode(String content)
    String Encode(byte[] bytes)
    byte[] EncodeToBytes(byte[] bytes)

RSA

静态方法：

    KeyPair GenerateKeys()
    KeyPair RestoreKeys(byte[] keyBytes)
    PublicKey ParsePublicKey(byte[] keyBytes)
    byte[] Encode(PublicKey pubKey, byte[] content)
    byte[] Decode(PrivateKey priKey, byte[] content)
    byte[] Sign(PrivateKey priKey, byte[] content)
    boolean Verify(PublicKey pubKey, byte[] content, byte[] sign)

SHA1

静态方法：

    String Encode(String content)
    String Encode(byte[] bytes)
    byte[] EncodeToBytes(byte[] bytes)

内置方法：

    long getTime() // 获取当前毫秒
    String fmt(String, Object...) // 格式化
    JSON.toJson(Object...) // Json化
    JSONObject JSON.parse(String) // String转JSONObject
    JSONArray JSON.parseArray(String) // String转JSONArray
    boolean isStrEmpty(String) // 判断字符串是否为空
    arraycopy(Object from, int fromOffset, Object to, int toOffset, int length) // 复制数组内容

示例：

• 场景1:

  用户在app提交了反馈，参数有”userObjectId”、”title”、”content”、”type”，需要保存到FeedBack表

    JSONObject params = request.getParams();
    String title = params.getString("title");
    String content = params.getString("content");
    String userId = params.getString("userObjectId");
    int type = params.getIntValue("type");
    JSONObject data = JSON.toJson(
        "title", title,
        "content", content,
        "type", type
    );
    BmobUpdater.add(
        data,
        "user",
        new BmobPointer("_User", userId)
    );
    response.send(
        modules.oData.insert(
            "Feedback",
            data
        ).stringData
    );

• 场景2:

  查询Feedback表中，type为1、title字段不为空，且创建时间在12小时以内的最新10条数据，并只需要反馈content和对应user的用户名

    Querier q = new Querier("Feedback")
                    .limit(10)
                    .include("user")
                    .order("-createdAt");
    q.addWhereEqualTo("type", 1);
    q.addWhereExists("title");
    q.addWhereGreaterThanOrEqualTo("createdAt",
        new BmobDate(getTime() - 12 * 60 * 60 * 1000)
    );
    HttpResponse res = modules.oData.find(q);
    JSONArray feedbacks = res.jsonData.getJSONArray("results");
    if (feedbacks == null)// 请求有错误，直接返回全部内容
        response.send(res.data);
    else {
        JSONArray arr = new JSONArray();
        for (int i = 0, l = feedbacks.size(); i < l; i++) {
            JSONObject fb = feedbacks.getJSONObject(i);
            JSONObject user = fb.getJSONObject("user");
            arr.add(
                JSON.toJson(
                    "username",
                    user == null ? null : user.getString("username"),
                    "content",
                    fb.getString("content")
                )
            );
        }
        response.send(JSON.toJson("results", arr));
    }

注意事项

• 如果你编写的Java云函数经常发生运行超时、上下行超流量、滥用内存等现象，官方将会自动封停你的云函数功能，修改后向客服申请方可继续使用

• 如果某接口调用频率较高，超过默认并发量，则会直接返回错误，解决方法：

    1.修改客户端代码，降低请求频率
    2.修改云函数，提高代码质量和效率，减少网络请求相关的超时时长，尽快结束工作
    3.购买更高的并发配置

• 如果需要接受更大的请求体，或返回更大的结果，请购买更高的配置