Java SDK

SDK安装

获取SDK

获取 SDK 有多种方式，较为推荐的方式是通过包依赖管理工具下载最新版本。

包依赖管理工具安装

通过 maven 配置相关依赖。

<dependencies>
	<dependency>
		<groupId>com.javabaas</groupId>
		<artifactId>javasdk</artifactId>
		<version>2.0.15</version>
	</dependency>
</dependencies>

或者通过 gradle 配置相关依赖。

dependencies {
	compile("com.javabaas:javasdk:2.0.15")
}

手动安装

Java_SDK 源码（码云gitee）
Java_SDK 源码（github）

初始化

首先使用JBShell工具获取我们需要使用的应用AppId、Key等信息。获取鉴权信息

JavaSDK提供三种权限的初始化方法，使用者可以根据实际情况使用相应的JavaSDK初始化方法：

初始化应用普通权限

在 main 函数中间调用 JB.init 来设置你的应用普通权限初始化的信息：

  public static void main(String[] args) {
	// 参数依次为 请求地址（例如：http://127.0.0.1:8080/api）、appId("594895b0b55198292ae266f1")、key("a8c18441d7ab4dcd9ed78477015ab8b2")
    JB.init("http://127.0.0.1:8080/api", "594895b0b55198292ae266f1","a8c18441d7ab4dcd9ed78477015ab8b2")
  }

提示: 普通权限用于操作数据，一般用于客户端程序。

初始化 master 权限

在 main 函数中间调用 JB.initAdmin 来设置你的 master 管理权限初始化的信息：

  public static void main(String[] args) {
	// 参数依次为 请求地址（例如：http://127.0.0.1:8080/api）、appId("594895b0b55198292ae266f1")、masterKey("cebde78a2d2d48c9870cf4887cbb3eb1")
    JB.initMaster("http://127.0.0.1:8080/api", "594895b0b55198292ae266f1","cebde78a2d2d48c9870cf4887cbb3eb1")
  }

提示: Master权限用于无视ACL的操作数据，一般用于后台云代码服务器。

初始化 admin 权限

在 main 函数中间调用 JB.initAdmin 来设置你的 admin 超级权限初始化的信息：

  public static void main(String[] args) {
	// 参数依次为 请求地址（"例如："http://127.0.0.1:8080/api"）、adminKey("JavaBaas")
    JB.initAdmin("http://127.0.0.1:8080/api", "JavaBaas")
  }

提示: Admin权限用于创建和管理应用

对象列表

JavaSDK目前提供了包括JBApp、JBClazz、JBField、JBObject、JBUser、JBQuery、JBFile等主要对象（除了这些主要的对象外，JavaSDK中还有一些内部类、工具类等，不再详细介绍）。

对象	描述
JBApp	应用对象
JBClazz	表对象，通常一个JBClazz对应一个mongoDB中的Collection
JBField	字段对象，对应mongoDB中的文档的ke
JBObject	文档对象
JBUser	用户
JBQuery	查询对象
JBFile	文件对象

JBObject 文档

JBObject是对JavaBaas对复杂对象的封装，通常一个JBObject对应一条文档数据。

JBObject 的一些主要的属性如下：

属性名	描述
objectId	文档id
className	文档对应的表名
createdAt	文档创建时间
updatedAt	文档更新时间
acl	文档级acl
serverData	文档非内建字段数据
query	JBQuery，查询条件，在findAndModify操作时候会用到
fetchWhenSave	保存成功后是否更新数据
operationQueue	所有字段待操作队列

JBObject提供的一些主要的方法为：

序号	方法	方法说明
1	save()	创建或者更新文档信息（同步)
2	saveInBackground(JBSaveCallback callback)	创建或者更新文档信息（异步）
3	delete()	删除文档信息（同步)
4	deleteInBackground(JBDeleteCallback callback)	删除文档信息（异步）

构建对象

你可以通过下面几种方式构建JBObject对象：

JBObject object = new JBObject("Sound");
object.setObjectId("objectId");

JBObject object = JBObject.create("Sound");

JBObject object = JBObject.createWithOutData("Sound", "objectId");

支持的数据类型

JBObject支持所有JBField字段类型。

JBObject object = JBObject.create("Sound");
// 字符串 String
object.put("name", "soundName");
// 数字 Number
object.put("size", 998);
// 布尔 Boolean
object.put("publish", true);
// 日期 Date
object.put("publishTime", new Date().getTime());
// 文件 File
JBFile file = new JBFile();
file.setObjectId("fileId");
object.put("soundFile", file);
// 对象 Object
Map<String, Object> m3u8 = new HashMap<>();
m3u8.put("ts1", "ts1url");
m3u8.put("ts2", "ts2url");
object.put("m3u8", m3u8);
// 数组 Array
List<String> tags = new ArrayList<>();
tags.add("流行");
tags.add("港台");
object.addArray("tag", tags);
// 指针 Pointer
JBUser user = JBUser.getCurrentUser();
object.put("user", user);

创建或者更新文档信息

使用者使用普通权限，可以创建或更新文档信息。如上面支持的数据类型中的例子，可以使用同步或者异步方法进行保存，JavaSDK会根据JBObject对象中是否存在objectId值而选择是创建或者更新操作。

// 同步
try {
	object.save();
} catch (JBException e) {
	System.out.println(e.getMessage());
}

// 异步
object.saveInBackground(new JBSaveCallback() {
	@Override
	public void done(boolean success, JBException e) {
		if (!success) {
			System.out.println(e.getMessage());
		}
	}
});

上面的代码执行后保存的数据如下：

{
    "_id" : "69af618624854cc9b77296b0c4c69524",
    "acl" : {
        "*" : {
            "read" : true,
            "write" : true
        }
    },
    "createdAt" : NumberLong(1510111638356),
    "updatedAt" : NumberLong(1510123750716),
    "createdPlat" : "cloud",
    "updatedPlat" : "cloud",
    "m3u8" : {
        "ts2" : "ts2url",
        "ts1" : "ts1url"
    },
    "name" : "soundName",
    "publish" : true,
    "publishTime" : NumberLong(1510123750685),
    "size" : 998,
    "user" : {
        "__type" : "Pointer",
        "className" : "_User",
        "_id" : "54710efba85e46a690034ba0df49e69d"
    },
    "tag" : [  
        "流行", 
        "港台"
    ],
    "soundFile" : {
        "__type" : "File",
        "className" : "_File",
        "_id" : "09258ae6cb484b20b3f075e2768cc43f",
        "url" : "http://youdomain.com/594895b0b55198292ae266f1/8a11682a0ca14cd1bd313812c0240e41",
        "name" : "2017_07_14_17_09"
    }
}

原子操作

原子操作是为解决不同客户端并发读取并修改同一文档的字段信息，因脏读而引发的写入数据错误。JBObject 目前支持六种原子操作：

操作	描述
removeKey	删除字段
addArray	Array类型字段添加值
addUniqueArray	Array类型字段添加与之前不重复的值
removeArray	Array类型字段删除值
increment	Number类型字段原子增加或原子减少
multiply	Number类型字段原子倍数增加

例如，原始数据为：

{
    "_id":"7e5ddc041a3b4661a0d2fd54ae288378",
    "size":998,
    "multiplySize":998,
    "name":"soundName",
    "tag":[
        "流行",
        "港台"
    ],
    "uniqueTag":[
        "流行",
        "港台"
    ],
    "removeTag":[
        "流行",
        "港台"
    ]
}

使用原子操作对上面的数据进行处理：

JBObject object = new JBObject("Sound");
// objectId为7e5ddc041a3b4661a0d2fd54ae288378的Sound文档
object.setObjectId("7e5ddc041a3b4661a0d2fd54ae288378");
// 删除字段的值
object.removeKey("name");
List<String> tags = new ArrayList<>();
tags.add("流行");
tags.add("内地");
// 添加数组
object.addArray("tag", tags);
// 添加unique数组
object.addUniqueArray("uniqueTag", tags);
// 去掉数组值的部分内容
object.removeArray("removeTag", tags);
// 原子增size值
object.increment("size");
// 原子倍数增multiplySize值
object.multiply("multiplySize", 10);
object.saveInBackground(new JBSaveCallback() {
	@Override
	public void done(boolean success, JBException e) {
		// code
	}
});

处理后的数据为：

{
    "_id":"7e5ddc041a3b4661a0d2fd54ae288378",
    "size":999,
    "multiplySize":9980,
    "tag":[
        "流行",
        "港台",
        "流行",
        "内地"
    ],
    "uniqueTag":[
        "流行",
        "港台",
        "内地"
    ],
    "removeTag":[
        "港台"
    ]
}

其他保存选项

JBObject支持在更新文档数据时查询当前文档是否满足一定条件，并且支持在更新后返回服务端的最新值。

使用setFetchWhenSave可以在更新数据后返回服务端的最新值。

object.setFetchWhenSave(true);

使用query可以在更新时判断当前文档是否满足一定条件。

// 判断当前文档中size是否大于0
JBQuery query = JBQuery.createQuery(object);
query.whereGreaterThan("size", 0);
object.setQuery(query);

删除文档信息

使用者使用普通权限，可以创建文档信息。

JBObject object = new JBObject("Sound");
object.setObjectId("7e5ddc041a3b4661a0d2fd54ae288378");
object.deleteInBackground(new JBDeleteCallback() {
	@Override
	public void done(boolean success, JBException e) {
		// code
	}
});

JBUser 用户

JBUser是JBObject子类，主要处理和用户有关的操作。

JBUser的一些主要的属性如下(除了父类JBObject属性外)：

属性名	描述
sessionToken	用户身份鉴权
username	用户名
email	邮箱
password	密码
phone	电话
auth	第三方登录信息

JBUser 提供的一些主要的方法为：

序号	方法	方法说明
1	signUp()	用户名密码注册（同步)
2	signUpInBackground(JBSignUpCallback callback)	用户名密码注册（异步）
3	getSmsCode(String phone)	获取短信验证码（同步)
4	getSmsCodeInBackground(String phone, JBGetSmsCodeCallback callback)	获取短信验证码（异步）
5	signUpWithSns(JBAuth auth, JBSnsType type)	第三方社交平台注册（同步)
6	signUpWithSnsInBackground(JBAuth auth, JBSnsType type, JBSignUpCallback callback)	第三方登录注册（异步）
7	login(String username, String password)	用户名密码登录（同步)
8	loginInBackground(String username, String password, JBLoginCallback callback)	用户名密码登录（异步）
9	loginWithPhone(String phone, String code)	手机号验证码登录（同步)
10	loginWithPhoneInBackground(String phone, String code, JBLoginCallback callback)	手机号验证码登录（异步）
11	loginWithSns(JBAuth auth, JBSnsType type)	第三方社交平台登录（同步)
12	loginWithSnsInBackground(JBAuth auth, JBSnsType type, JBLoginCallback callback)	第三方社交平台登录（异步）
13	updatePassword(String oldPassword, String newPassword)	修改登录密码（同步)
14	updatePasswordInBackground(String oldPassword, String newPassword, JBUpdatePasswordCallback callback)	修改登录密码（异步）
15	update()	更新用户信息（同步)
16	updateInBackground(JBUpdateCallback callback)	更新用户信息（异步）
17	resetSessionToken(String userId)	重置用户sessionToken（同步)

用户名密码注册

使用者可以使用普通权限使用用户名密码进行注册：

JBUser user = new JBUser();
// 用户名，用户名规则为"^[a-zA-Z0-9_@.]*$"
user.setUsername("woshiwo");
// 密码
user.setPassword("aaaaaa");
user.signUpInBackground(new JBSignUpCallback() {
	@Override
	public void done(boolean success, JBException e) {
		//
	}
});

第三方社交平台注册

使用者可以使用普通权限可以通过第三方平台注册。

try {
	JBUser user = new JBUser();
	user.setUsername("woshiwo");
	
	JBAuth auth = new JBAuth();
	// 微博、qq、微信需要accessToken
	String accessToken = "xxxxxx";
	auth.setAccessToken(accessToken);
	// 微博需要uid
	String uid = "xxxx";
	auth.setUid(uid);
	// 微信、qq、微信小程序需要openId或unionId，当两者都赋值的话优先使用unionId。
	String openId = "xxxxx";
	String unionId = "xxxxx";
	auth.setOpenId(openId);
	auth.setUnionId(unionId);
	// 微信小程序需要encryptedData、code和iv
	String encryptedData = "xxxxx";
	String code = "xxxx";
	String iv = "xxxxx";
	auth.setEncryptedData(encryptedData);
	auth.setCode(code);
	auth.setIv(iv);
		
	// 根据实际，选择不同的type
	JBSnsType type = JBSnsType.WEBAPP;

	user.signUpWithSns(auth, type);
} catch (JBException e) {
	System.out.println(e.getMessage());
}

用户名密码登录

使用者可以使用普通权限可以通过用户名密码登录，登录成功后，服务端会返回该用户的所有可见信息和用户鉴权用的sessionToken。

JBUser.loginInBackground("woshiwo", "aaaaaa", new JBLoginCallback() {
	@Override
	public void done(boolean success, JBUser user, JBException e) {
		// 更新currentUser
		JBUser.updateCurrentUser(user);
	}
});

获取短信验证码

使用者可以使用普通权限使用手机号验证码登录时可以通过下面的方法获取短信验证码：

try {
	JBUser.getSmsCode("18988888888");
} catch (JBException e) {
	System.out.println(e.getMessage());
}

手机号验证码登录

使用者可以使用普通权限，在获取到手机有效验证码后可以通过手机号验证码方式登录，需要注意的是如果用户之前没有注册，服务端会自动为改手机号注册一个用户，用户名默认为 “phone_” 加手机号。

JBUser.loginWithPhoneInBackground("18988888888", "smsCode", new JBLoginCallback() {
	@Override
	public void done(boolean success, JBUser user, JBException e) {
		// code
	}
});

第三方社交平台登录

使用者可以使用普通权限，并且已经通过第三方平台注册过，可以使用第三方社交平台进行登录：

// auth和snsType参考第三方社交平台注册
JBUser.loginWithSnsInBackground(auth, snsType, new JBLoginCallback() {
	@Override
	public void done(boolean success, JBUser user, JBException e) {
		// code
	}
});

修改登录密码

使用者可以使用普通权限，可以在登录成功后修改本人的用户名登录密码：

// 旧密码为"aaaaaaa"， 新密码为"bbbbbb"
user.updatePasswordInBackground("aaaaaaa", "bbbbbb", new JBUpdatePasswordCallback() {
	@Override
	public void done(boolean success, String sessionToken, JBException e) {
		// code
	}
});

更新用户信息

使用者可以使用普通权限，在成功登录后可以修改本人的一些信息：

user.put("nickname", "小王");
user.updateInBackground(new JBUpdateCallback() {
	@Override
	public void done(boolean success, JBException e) {
		//code
	}
});

重置用户sessionToken

使用者可以使用普通权限，在成功登录后可以重置本人的sessionToken，重置完sessionToken后，所有设备登录的该用户都会被下线。

JBUser user = JBUser.getCurrentUser();
try {
	JBUser.resetSessionToken(user.getObjectId());
} catch (JBException e) {
	e.printStackTrace();
}

JBQuery 查询

JBQuery主要处理和查询有关的操作。

JBQuery的一些主要的属性如下：

属性名	描述
className	类名
whereSting	查询语句(json串)
isRunning	是否正在查询
conditions	查询条件

JBUser 提供的一些主要的方法为：

序号	方法	方法说明
1	get(String objectId)	根据objectId获取对象（同步)
2	getInBackground(String objectId, JBGetCallback callback)	根据objectId获取对象（异步）
3	find()	数据查询（同步)
4	findInBackground(JBFindCallBack callBack)	数据查询（异步）
5	count()	简单统计查询（同步)
6	countInBackground(JBCountCallback callback)	简单统计查询（异步）
7	deleteByQuery()	批量删除（同步)
8	deleteByQueryInBackground(JBDeleteCallback callback)	批量删除（异步）

根据objectId获取对象

使用者可以通过文档的objectId获取有读权限的文档数据：

JBQuery query = new JBQuery("Sound");
query.getInBackground("7e5ddc041a3b4661a0d2fd54ae288378", new JBGetCallback() {
	@Override
	public void done(boolean success, JBObject object, JBException e) {
		// code
	}
});

数据查询

使用者可以通过设置一些查询条件查询有读权限的相关数据，需要注意的是用户不设置查询数量限制的前提下，服务端默认返回符合条件最多100条数据，用户也可以自己设置最大返回数据量，范围为1到1000，超过1000服务端按1000条算，查询的默认排序是根据文档数据的updatedAt倒叙排序。

// 构建基于Sound表的查询
JBQuery query = new JBQuery("Sound");
// 查询name等于soudName的数据
query.whereEqualTo("name", "soudName");
// 查询name等于otherName的数据
query.whereNotEqualTo("name", "otherName");
// 查询size小于10的数据
query.whereLessThan("size", 10);
// 查询size大于0的数据
query.whereGreaterThan("size", 0);
// 查询size小于等于10的数据
query.whereLessThanOrEqualTo("size", 10);
// 查询size大于等于0的数据
query.whereGreaterThanOrEqualTo("size", 0);
// 查询name字段不为空的数据
query.whereExists("name");
// 查询name字段为空的数据
query.whereNotExist("name");
// 查询name字段中包含“sound”字符串的数据
query.whereContains("name", "sound");
 
List<String> list = new ArrayList<>();
list.add("港台");
// 查询tag中含有list中数据的数据
query.whereContainedIn("tag", list);
// 查询tag中不含有list中数据的数据
query.whereNotContainedIn("tag", list);
// 查询name字段以“me”字符串结尾的数据
query.whereEndWith("name", "me");
// 查询name字段以“sou”字符串开头的数据
query.whereStartWith("name", "sou");

// 查询根据正则表达式查询的数据
String regex = ".*o.*";
String options = "i";
query.whereMatches("name", regex);
query.whereMatches("name", regex, options);

// 设置查询结果返回数量最大为30
query.setLimit(30);
// 设置查询跳过符合条件的前60个
query.setSkip(60);
// 按createdAt的倒叙排序
query.addDescendingOrder("createdAt");
// 按size的正序排序
query.addAscendingOrder("size");
// 查询user的全部信息，只针对Pointer类型字段
// 如果查询的字段对应的文档中还有Pointer字段，并且也需要查询出来
// 则可以使用“album.user”（album是当前表中的Pointer字段，user是Album表中的一个Pointer字段）
query.include("user");

query.findInBackground(new JBFindCallBack() {
	@Override
	public void done(boolean success, List objects, JBException e) {
		// code
	}
});

子查询

子查询是数据查询的一种，用于构建复杂一些的查询。

例如，音频 Sound 类中有一个字段作者 user 是一个 Pointer 字段，它指向 _User 类，现在我们要查询用户的昵称 nickname 中含有 ABC 字符串的用户发布的所有音频。

JBQuery query = new JBQuery("Sound");
JBQuery subQuery = new JBQuery("_User");
subQuery.whereContains("nickName", "ABC");
query.whereMatchesQuery("user", subQuery);
query.findInBackground(new JBFindCallBack() {
	@Override
	public void done(boolean success, List objects, JBException e) {
		// code
	}
});

还一种情况，例如音频 Sound 类中有一个字段专辑 album 是一个 Pointer 字段，指向 Album 类，专辑订阅信息 SubscriptionAlbum 类中有两个 Pointer 类型字段订阅者 user 和专辑 subsAlbum (为了跟 Sound 中的 album 区分，这个字段名称命名为 subsAlbum ) ，分别指向 _User 和 Album 类，现知道用户 A ，其 _id 为 a6159350c5964cebbe523d679b9889ae ，要查询用户 A 订阅的专辑的所有音频数据。

JBQuery query = new JBQuery("Sound");
JBQuery subQuery = new JBQuery("SubscriptionAlbum");
JBUser user = new JBUser();
user.setObjectId("a6159350c5964cebbe523d679b9889ae");
subQuery.whereEqualTo("user", user);
query.whereMatchesKeyInQuery("album", "subsAlbum", subQuery, "Album");
query.findInBackground(new JBFindCallBack() {
	@Override
	public void done(boolean success, List objects, JBException e) {
		// code
	}
});

简单统计查询

使用者可以使用普通权限，对某表的数据根据一定条件查询。

JBQuery query = new JBQuery("Sound");
query.whereGreaterThanOrEqualTo("size", 10);
query.countInBackground(new JBCountCallback() {
	@Override
	public void done(boolean success, int count, JBException e) {
		// code
	}
});

批量删除

使用者可以根据查询条件批量删除一些有删除权限的文档。

query.deleteByQueryInBackground(new JBDeleteCallback() {
	@Override
	public void done(boolean success, JBException e) {
		// code
	}
});

JBFile 文件

JBFile是JBObject的子类，主要处理和文件有关的操作。

JBFile 的一些主要的属性如下：

属性名	描述
url	链接地址
name	名称

JBApp 应用

JBApp主要是处理在 admin 超级权限或者当前应用的 master 管理权限下对应用的管理。

JBApp的一些重要的属性如下：

属性名	描述
id	应用id 既 appId
name	应用名称
key	本应用普通权限的key
masterKey	本应用的管理权限key
cloudSetting	本应用相关的云方法和钩子设置

JBApp提供的一些主要的方法为：

序号	方法	方法说明
1	save()	创建或更新应用信息（同步）
2	saveInBackground(JBSaveCallback callback)	创建或更新应用信息（异步）
3	delete()	删除应用（同步）
4	deleteInBackground（JBDeleteCallback callback）	删除应用（异步）
5	get(String appId)	获取应用信息（同步）
6	getInBackground(String appId, JBGetAppCallback callback)	获取应用信息（异步）
7	resetKey(int type)	更新应用key或masterKey值（同步）
8	resetKeyInBackground(int type, JBUpdateCallback callback)	更新应用key或masterKey值（异步）
9	list()	获取应用列表（同步）
10	listInBackground(JBAppListCallback callback)	获取应用列表（异步）
11	export(String appId)	导出应用信息（同步）
12	exportInBackground(String appId, JBAppExportCallback callback)	导出应用信息（异步）
13	importData(String data)	导入应用信息（同步）
14	importDataInBackground(String data, JBImportCallback callback)	导入应用信息（异步）
15	getApiStat(JBApiStat apiStat)	获取应用api调用统计（同步）
16	getApiStatInBackground(JBApiStat apiStat, JBApiStatListCallback callback)	获取应用api调用统计（异步）
17	updateAppConfig(JBAppConfig config)	更新应用设置（同步）
18	updateAppConfigInBackground(JBAppConfig config, JBUpdateCallback callback)	更新应用设置（异步）
19	getAppConfig(JBAppConfigKey appConfigKey)	查看应用config信息（同步）
20	getAppConfigInBackground(JBAppConfigKey appConfigKey, JBGetConfigCallback callback)	查看应用config信息（异步）

创建或更新应用信息

使用者可以在设置了admin超级权限后可以通过调用创建或更新应用信息方法创建或者更新应用：

try {
	JBApp app = new JBApp();
	app.setName("应用名称");
	app.save();
	System.out.println("创建应用成果");
} catch (JBException e) {
	System.out.println(e.getMessage());
}

删除应用

使用者拥有了admin超级权限后可以通过调用删除应用方法删除应用：

JBApp app = new JBApp();
app.setId("appId");
app.deleteInBackground(new JBDeleteCallback() {
	@Override
	public void done(boolean success, JBException e) {
		if (success) {
			System.out.println("应用删除成功");
		} else {
			System.out.println(e.getMessage());
		}
	}
});

获取应用信息

使用者拥有了admin超级权限后可以通过调用获取应用信息的方法获取应用信息。

try {
	JBApp app = JBApp.get("appId");
	System.out.println(app);
} catch (JBException e) {
	System.out.println(e.getMessage());
}

重置应用key或masterKey值

使用者拥有了admin超级权限后可以重置应用key或masterKey值，需要注意的是，一旦重置了应用key或masterKey值，之前的key或masterKey立即不能使用，可能会影响之前已经上线的应用。

app.resetKeyInBackground(1, new JBUpdateCallback() {
	@Override
	public void done(boolean success, JBException e) {
		if (success) {
			System.out.println("更改应用key成功");
		} else {
			System.out.println(e.getMessage());
		}
	}
});

获取应用列表

使用者拥有了admin超级权限后可以获取应用列表，查看所有应用信息。

try {
	List<JBApp> list = JBApp.list();
	list.forEach(app -> System.out.println(app.getId() + " : " + app.getName()));
} catch (JBException e) {
	System.out.println(e.getMessage());
}

结果如下：

59dc970bce69f81448a2a119 : NewApp
59f0173012a0aa06cb853985 : TestApp

导出应用信息

使用者拥有了admin超级权限后可以使用应用信息导出方法备份应用的结构信息，需要注意的是导出的时候结构信息，不含表中数据。

JBApp app = new JBApp();
app.setId("59dc970bce69f81448a2a119");
JBApp.exportInBackground("59dc970bce69f81448a2a119", new JBAppExportCallback() {
	@Override
	public void done(boolean success, JBApp.JBAppExport appExport, JBException e) {
		if (success) {
			System.out.println(appExport);
		}
	}
});

结果如下：

{
    "id":"59dc970bce69f81448a2a119",
    "name":"NewApp",
    "key":"cde5b8c5e097436aafe6377e33eeb003",
    "masterKey":"c57cd396c2034ef6a6ae1c74b7596730",
    "clazzs":[
        Object{...},
        Object{...},
        Object{...},
        Object{...},
        Object{...},
        {
            "id":"59dc9869ce69f81448a2a13e",
            "name":"Test",
            "acl":{
                "*":{
                    "find":true,
                    "get":true,
                    "insert":true,
                    "update":true,
                    "delete":true
                }
            },
            "internal":false,
            "fields":[
                {
                    "id":"59dc9869ce69f81448a2a13f",
                    "name":"count",
                    "type":2,
                    "internal":false,
                    "security":false,
                    "notnull":false
                },
                {
                    "id":"59e970a212a0aa7f91bb0487",
                    "name":"name",
                    "type":1,
                    "internal":false,
                    "security":false,
                    "notnull":false
                },
                Object{...}
            ]
        }
    ]
}

导入应用信息

使用者拥有了admin超级权限后可以使用导入应用信息回复应用结构信息，需要注意的是导入的只是应用结构信息，包括应用信息、表信息、字段信息等，不含表中文档内容。

try {
	String data = "{\"id\":\"59dc970bce69f81448a2a119\",\"name\":\"NewApp\",\"key\":\"cde5b8c5e097436aafe6377e33eeb003\",\"masterKey\":\"c57cd396c2034ef6a6ae1c74b7596730\",\"clazzs\":[{\"id\":\"59dc9869ce69f81448a2a13e\",\"name\":\"Test\",\"acl\":{\"*\":{\"find\":true,\"get\":true,\"insert\":true,\"update\":true,\"delete\":true}},\"internal\":false,\"fields\":[{\"id\":\"59dc9869ce69f81448a2a13f\",\"name\":\"count\",\"type\":2,\"internal\":false,\"security\":false,\"notnull\":false},{\"id\":\"59e970a212a0aa7f91bb0487\",\"name\":\"name\",\"type\":1,\"internal\":false,\"security\":false,\"required\":false}]}]}";
	JBApp.importData(data);
	System.out.println("导入应用成功");
} catch (JBException e) {
	System.out.println(e.getMessage());
}

获取应用api调用统计

使用者拥有了当前应用的master管理权限后，使用该方法可以获取当前应用api的调用统计，下面的查询是查询昨天和今天两天，来之web端（plat为js）的有关_User 的 insert 操作请求的统计：

JBApp app = new JBApp();
app.setId("59dc970bce69f81448a2a119");
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd");
Calendar calendar = new GregorianCalendar();
// 今天 例如20171106
Date to = calendar.getTime();
calendar.add(Calendar.DAY_OF_YEAR, -1);
// 昨天 例如20171105
Date from = calendar.getTime();
String fromString = simpleDateFormat.format(from);
String toString = simpleDateFormat.format(to);
JBApp.JBApiStat apiStat = new JBApp.JBApiStat("js", "_User", JBApp.JBApiMethod.INSERT, fromString, toString);
app.getApiStatInBackground(apiStat, new JBApiStatListCallback() {
	@Override
	public void done(boolean success, List<Long> list, JBException e) {
		if (success) {
			System.out.println(list);
		}
	}
});

更新应用设置

使用者拥有了当前应用的master管理权限后，使用该方法可以对当前应用的config信息进行修改：

try {
	JBApp.JBAppConfig config = new JBApp.JBAppConfig();
	config.setAppConfigKey(JBApp.JBAppConfigKey.PUSH_HANDLER_JPUSH_KEY);
	config.setValue("jpushKey");
	JBApp.updateAppConfig(config);
	System.out.println("设置成功");
} catch (JBException e) {
	System.out.println(e.getMessage());
}

查看应用config信息

使用者拥有了当前应用的master管理权限后，使用该方法可以查看当前应用的一些config信息：

try {
	String value = JBApp.getAppConfig(JBApp.JBAppConfigKey.PUSH_HANDLER_JPUSH_KEY);
	System.out.println(value);
} catch (JBException e) {
	System.out.println(e.getMessage());
}

JBClazz 表

JBClazz主要处理在当前应用的master权限下，和表有关的操作。

JBClazz的一些重要的属性如下：

属性名	描述
id	表id
app	应用信息
name	表名称
acl	表级权限
internal	是否是内部类
count	当前表中文档数据量

JBClazz提供的一些主要的方法为：

序号	方法	方法说明
1	save()	创建或更新表信息（同步）
2	saveInBackdround(JBSaveCallback callback)	创建或更新表信息（异步）
3	delete()	删除表信息（同步）
4	deleteInBackground(JBDeleteCallback callback)	删除表信息（异步）
5	get(String name)	获取表信息（同步）
6	getInBackground(String name, JBGetClazzCallback callback)	获取表信息（异步）
7	updateClazzAcl()	更新表级acl（同步）
8	updateClazzAclInBackground(JBUpdateCallback callback)	更新表级acl（异步）
9	list()	获取表列表信息（同步）
10	listInBackground(JBClazzListCallback callback)	获取表列表信息（异步）
11	export(String className)	导出表结构信息（同步）
12	exportInBackground(String className, JBClazzExportCallback callback)	导出表结构信息（异步）
13	importData(String data)	导入表结构信息（同步）
14	importDataInBackground(String data, JBImportCallback callback)	导入表结构信息（异步）

创建或更新表信息

使用者拥有了当前应用的master管理权限后，可以创建或更新表信息。

try {
	JBClazz clazz = new JBClazz("Sound");
	// 创建clazz的时候可以通过设置JBClazzAcl加强对clazz的控制，如果不设置，默认clazz的所有acl为public true
	JBClazz.JBClazzAcl acl = new JBClazz.JBClazzAcl();
	acl.setAccess(JBClazz.ClazzAclMethod.DELETE, "userId", true);
	acl.setPublicAccess(JBClazz.ClazzAclMethod.FIND, true);
	acl.setPublicAccess(JBClazz.ClazzAclMethod.GET, true);
	clazz.setAcl(acl);
	clazz.save();
} catch (JBException e) {
	System.out.println(e.getMessage());
}

新建的clazz数据：

{
    "_id" : ObjectId("5a015ad3fa0a5737c68c1c9d"),
    "_class" : "com.javabaas.server.admin.entity.Clazz",
    "name" : "Sound",
    "acl" : {
        "userId" : {
            "delete" : true
        },
        "*" : {
            "find" : true,
            "get" : true
        }
    },
    "internal" : false,
    "count" : NumberLong(0),
    "app" : {
        "$ref" : "app",
        "$id" : ObjectId("594895b0b55198292ae266f1")
    }
}

删除表信息

使用者拥有了当前应用的master管理权限后，可以删除表信息。

JBClazz clazz = new JBClazz("Sound");
clazz.deleteInBackground(new JBDeleteCallback() {
	@Override
	public void done(boolean success, JBException e) {
		// code
	}
});

获取表信息

使用者拥有了当前应用的master管理权限后，可以根据表名称获取表结构信息。

JBClazz.getInBackground("Sound", new JBGetClazzCallback() {
	@Override
	public void done(boolean success, JBClazz clazz, JBException e) {
		// code
	}
});

更新表级acl

使用者拥有了当前应用的master管理权限后，可以更新表级acl。表级acl包括对表的insert新增文档，update修改文档，get获取单个文档信息，find查询表文档，delete删除文档等，如果没有单独设置表级acl，则表级acl所有权限均为public true。而如果五个权限中只设置了其中的一些，则未设置的权限为public false。另外，每次更新标记acl，新的acl会替换旧的acl，而不是对旧的acl进行补充设置（类似于求并集），所以比如，即使你只是想改变insert的权限，而不想改变之前其他四种权限的设置，你也需要在更新时候对其他权限进行重新设置。

JBClazz clazz = new JBClazz("Sound");
JBClazz.JBClazzAcl acl = new JBClazz.JBClazzAcl();
acl.setPublicAccess(JBClazz.ClazzAclMethod.INSERT, false);
acl.setPublicAccess(JBClazz.ClazzAclMethod.UPDATE, true);
acl.setPublicAccess(JBClazz.ClazzAclMethod.GET, true);
acl.setPublicAccess(JBClazz.ClazzAclMethod.FIND, true);
acl.setPublicAccess(JBClazz.ClazzAclMethod.DELETE, true);
clazz.setAcl(acl);
clazz.updateClazzAclInBackground(new JBUpdateCallback() {
	@Override
	public void done(boolean success, JBException e) {
		// code
	}
});

获取表列表信息

使用者拥有了当前应用的master管理权限后，可以查询全部表的列表信息。

JBClazz.listInBackground(new JBClazzListCallback() {
	@Override
	public void done(boolean success, List<JBClazz> list, JBException e) {
		// code
	}
});

导出表结构信息

使用者拥有了当前应用的master管理权限后，可以导出表结构信息，需要注意的是只是导出表结构信息，不含表中文档内容。

try {
	JBClazz.JBClazzExport export = JBClazz.export("Sound");
	// JBUtils.writeValueAsString是JavaSDK提供的工具类的方法
	System.out.println(JBUtils.writeValueAsString(export));
} catch (JBException e) {
	System.out.println(e.getMessage());
}

导出结果为：

{
    "id":"5a015ad3fa0a5737c68c1c9d",
    "name":"Sound",
    "acl":{
        "userId":{
            "delete":true
        },
        "*":{
            "find":true,
            "get":true
        }
    },
    "internal":false,
    "fields":[
        {
            "id":"5a016241fa0a5737c68c1c9e",
            "name":"title",
            "type":1,
            "internal":false,
            "security":false,
            "notnull":false
        }
    ]
}

导入表结构信息

使用者拥有了当前应用的master管理权限后，可以导入表结构信息，需要注意的是只是导入表结构信息，不含表中文档内容。

String data = "{\"id\":\"5a015ad3fa0a5737c68c1c9d\",\"name\":\"Sound\",\"acl\":{\"userId\":{\"delete\":true},\"*\":{\"find\":true,\"get\":true}},\"internal\":false,\"fields\":[{\"id\":\"5a016241fa0a5737c68c1c9e\",\"name\":\"title\",\"type\":1,\"internal\":false,\"security\":false,\"notnull\":false}]}";
JBClazz.importDataInBackground(data, new JBImportCallback() {
	@Override
	public void done(boolean success, JBException e) {
		//code
	}
});

JBField 字段

JBField主要处理在当前应用的 master 权限下，和字段有关的操作。

JBField的一些重要的属性如下：

属性名	描述
id	表id
clazz	表信息
name	字段名称
type	字段类型（详见字段类型说明）
internal	是否是内建字段，内建字段不能进行删除字段操作
security	是否是安全字段，安全字段必须需要 master 管理权限才可以修改
notnull	是否是必填字段

JBField提供的一些主要的方法为：

序号	方法	方法说明
1	save()	创建或更新字段信息（同步）
2	saveInBackground(JBSaveCallback callback)	创建或更新字段信息（异步）
3	delete()	删除字段信息（同步）
4	deleteInBackground(JBDeleteCallback callback)	删除字段信息（异步）
5	update()	更新字段信息（同步）
6	updateInBackground(JBUpdateCallback callback)	更新字段信息（异步）
7	get(String className, String fieldName)	获取字段信息（同步）
8	getInBackground(String className, String fieldName, JBGetFieldCallback callback)	获取字段信息（异步）
9	list(String className)	获取字段列表信息（同步）
10	listInBackground(String className, JBFieldListCallback callback)	获取字段列表信息（异步）

创建或更新字段信息

使用者拥有了当前应用的master管理权限后，可以创建或者更新字段信息，JavaSDK 目前提供8种字段类型：

序号	字段类型	说明
1	String	字符串
2	Number	数字
3	Boolean	布尔型
4	Date	日期
5	File	文件
6	Object	对象
7	Array	数组
8	Pointer	指针

try {
	// type 为字段类型的序号
	JBField field = new JBField(1, "title");
	field.setClazz(new JBClazz("Sound"));
	// 是否必填，默认为false
	field.setNotnull(true);
	// 是否内建，默认为false
	field.setInternal(true);
	// 是否为安全字段，安全字段信息在获取数据时不会带出，默认为false
	field.setSecurity(true);
	field.save();
} catch (JBException e) {
	System.out.println(e.getMessage());
}

删除字段信息

使用者拥有了当前应用的master管理权限后，可以删除字段信息，需要注意的是，因为mongoDB本身没有字段概念，只有key，本方法只是删除了JavaBaas中的字段的定义，不会删除文档中相关的key和对应的value，但是在用户查询过程中，该key和对应的value不在对用户展示。

try {
	JBField field  = new JBField();
	field.setName("Sound");
	field.delete();
} catch (JBException e) {
	System.out.println(e.getMessage());
}

更新字段信息

使用者拥有了当前应用的master管理权限后，可以对字段信息进行更新，目前更新字段信息只限于更新字段的security，notNull属性。

try {
	JBField field  = new JBField();
	field.setName("Sound");
	field.setSecurity(false);
	field.update();
} catch (JBException e) {
	System.out.println(e.getMessage());
}

获取字段信息

使用者拥有了当前应用的master管理权限后，可以查询字段信息。

try {
	// 两个参数分别为表名和字段名
	JBField field  = JBField.get("Sound", "title");
} catch (JBException e) {
	System.out.println(e.getMessage());
}

获取字段列表信息

使用者拥有了当前应用的master管理权限后，可以查看某个表中所有字段信息。

JBField.listInBackground("Sound", new JBFieldListCallback() {
	@Override
	public void done(boolean success, List<JBField> list, JBException e) {
		// code
	}
});

Name		Name	Last commit message	Last commit date
Latest commit History 51 Commits
src/main/java/com/javabaas/javasdk		src/main/java/com/javabaas/javasdk
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

License

JavaBaas/JavaBaas_SDK_Java

Folders and files

Latest commit

History

Repository files navigation