Merge pull request #5 from codi/master

1.0.0发布版本

README.md

@@ -1,12 +1,299 @@
 # JavaBaas
-JavaBaas是基于Java语言开发的移动客户端后台开发框架，其核心设计目标是实现移动客户端的后台结构化数据存储、物理文件存储、消息推送等功能。极大的降低移动客户端的后台开发难度，实现快速开发。
+**JavaBaas** 是基于Java语言开发的后台服务框架，其核心设计目标是实现移动客户端的后台结构化数据存储、物理文件存储、消息推送等功能。极大的降低移动客户端的后台开发难度，实现快速开发。
+
+项目地址：[GitHub](https://github.com/JavaBaas/JavaBaasServer)
+
+技术讨论群：479167886
+
+完整文档参见：[www.javabaas.com](http://www.javabaas.com/)
+
+备注: [JavaBaas稳定版下载地址](http://7xr649.dl1.z0.glb.clouddn.com/JavaBaas.zip)
 
 ## 主要功能
-* 基于文档数据库的结构化数据存储
-* 基于ACL的权限管理机制
+* 结构化数据存储
+* 物理文件存储
+* ACL权限管理机制
 * 用户系统
-* 基于云存储的物理文件存储
 * 消息推送
 
-完整文档参见[http://www.javabaas.com](http://www.javabaas.com/)
-技术讨论群:479167886
+##快速上手
+
+###相关环境
+####JDK
+JavaBaas基于JDK1.8编写，编译及运行需要安装JDK1.8环境。
+
+提示: 在Oracle官网可以下载最新的[JDK安装包](http://www.oracle.com/technetwork/java/javase/downloads/index.html)。
+
+####MongoDB
+JavaBaas使用MongoDB作为存储数据库，请先正确安装并启动MongoDB数据库。
+
+提示: 在MongoDB官网可以下载最新的[MongoDB安装包](www.mongodb.com)。
+
+####Redis
+JavaBaas使用Redis作为缓存引擎，请先正确安装并启动Redis数据库。
+
+提示: 在Redis官网可以下载最新的[Redis安装包](http://redis.io/)。
+
+###启动
+Server目录下的`JavaBaas.jar`为系统启动文件，系统依赖环境配置正确后，使用以下命令启动系统：
+
+`java -jar JavaBaas.jar`
+看到以下信息，表明系统启动成功。
+
+```
+[main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
+[main] c.s.b.c.l.ApplicationEventListener       : JavaBaasServer started.
+[main] c.j.s.c.l.ApplicationEventListener       : Key: JavaBaas
+[main] c.j.s.c.l.ApplicationEventListener       : Timeout: 600000
+[main] com.staryet.baas.Main                    : Started Main in 2.653 seconds (JVM running for 3.232)
+```
+
+###命令行工具
+`JavaBaas`系统成功启动后，默认将在http 8080端口监听所有用户请求。此时首先要使用命令行工具`JBShell`创建应用。
+
+命令行工具`JBShell`是JavaBaas的配套工具，使用`JBShell`可以完成应用的创建删除、类的创建删除、字段的创建删除、对象的增删改查等操作，以及一些便捷的辅助功能。
+
+`JBShell`基于java编写，编译及运行需要安装JDK环境。
+
+使用以下命令启动命令行工具：
+
+`java -jar JBShell.jar`
+
+启动成功后显示以下信息
+
+```
+   ___                     ______
+  |_  |                    | ___ \
+    | |  __ _ __   __ __ _ | |_/ /  __ _   __ _  ___
+    | | / _` |\ \ / // _` || ___ \ / _` | / _` |/ __|
+/\__/ /| (_| | \ V /| (_| || |_/ /| (_| || (_| |\__ \
+\____/  \__,_|  \_/  \__,_|\____/  \__,_| \__,_||___/
+Version:1.0.0
+Host:http://localhost:8080/api/
+AdminKey:JavaBaas
+BAAS>
+```
+
+###配置
+`JBShell.jar `为命令行工具执行文件。同目录下的`config.properties`为配置文件。内容如下：
+
+```
+host = http://localhost:8080/api/
+key = JavaBaas
+```
+
+其中`host`为`JavaBaas`服务器所在的地址，本地调用`JBShell`默认使用localhost即可，远程管理需设置正确的远程服务器地址。
+
+`key`为`JavaBaas`超级密钥，不设置默认为JavaBaas。
+
+###创建应用
+在`JavaBaas`中，最高层的组织结构为应用系统，各应用之间权限、用户、数据相互隔离。为了开始使用`JavaBaas`，我们首先需要创建一个应用。
+
+首先启动命令行工具，在命令行工具中，使用命令`app add Blog`，创建一个博客应用。
+
+```bash
+BAAS>app add Blog
+App added.
+```
+现在，我们成功创建了一个名为`Blog`的应用。
+
+提示: 一般情况下建议使用大写字母开头做为应用名称
+
+####查看应用列表
+在命令行工具中，使用`apps`命令可以查看当前`JavaBaas`中所有的应用。
+
+```
+BAAS>apps
+Blog
+```
+现在我们可以看到，系统中只有我们刚刚创建的，名为`Blog`的一个应用。
+
+####切换当前应用
+在命令行工具中，使用`use`命令即可切换当前应用，切换应用后，即可为当前应用创建类来存储数据。
+
+```
+BAAS>use Blog
+Set current app to Blog
+```
+现在我们的应用即切换为刚刚创建的`Blog`。
+
+####创建类
+在`JavaBaas`中，数据使用类进行组织。用户可以自由创建类，类名需使用英文字母开头且名称中只能包含数字与英文字母。类创建后，需要在类中创建字段以存储数据。同时、系统初始化后会自动创建用户类、设备类、文件类等系统内建类，内建类名使用下划线`_`开头，系统内建类禁止删除或修改。
+
+现在我们使用命令`class add Article`创建一个类用于存储博客中的文章信息。
+
+```
+Blog>class add Article
+Class added.
+```
+现在我们便在`Blog`应用中创建了名为`Article`的类。
+
+提示: 一般情况下建议使用大写字母开头做为类名称
+
+####查看类列表
+使用`class`命令，可以查看当前应用下所有的类。
+
+```
+Blog>class
+_File(0)
+_Installation(0)
+_PushLog(0)
+_User(0)
+Article(0)
+```
+可以看到，当前应用中存在系统内建的文件类、设备类、推送日志类、用户类，以及我们刚刚创建的用于存储文章的`Article`类。
+
+####切换当前类
+成功创建`Article`类后，我们需要为类创建用于存储文章标题、作者等信息的字段以存储数据。首先，我们需要将当前类切换至`Article`以便在此类下创建字段。
+
+使用`set Article`命令，将当前类切换至`Article`
+
+```
+Blog>set Article
+Set current class to Article
+Blog Article>
+```
+切换完成后，光标变为`Blog Article>`，表示当前应用为`Blog`，当前类为`Article`。
+
+###创建字段
+使用`field add title`命令，在`Article`类中创建一个用于存储文章标题的字符型字段。
+
+```
+Blog Article>field add title
+Field added.
+Blog Article>
+```
+现在我们在类`Article`中创建了名为`title`的字符型字段。
+
+使用`field add author`命令，在`Article`类中创建一个用于存储文章作者的字符型字段。
+
+```
+Blog Article>field add author
+Field added.
+Blog Article>
+```
+现在我们在类`Article`中创建了名为`author`的字符型字段。
+
+提示: 一般情况下建议使用小写字母开头做为字段名称
+
+####查看字段列表
+使用命令`fields`即可查看当前类中的所有字段列表。
+
+```
+Blog Article>fields
+<STRING>  author
+<STRING>  title
+```
+可以看到，当前类中存在两个我们刚创建的字符型字段。
+
+###存储数据
+成功创建类并添加字段后，我们可以开始存储数据。使用命令行工具即可以进行基本的增删改查操作。
+
+####插入数据
+使用命令`add`在`Article`类中插入数据。
+
+```
+Blog Article>add {"title":"StarWars","author":"Lucas"}
+Object added.
+```
+
+现在我们便在`Article`类中插入了一条数据记录。
+
+提示: 在 JavaBaas 中，所有数据以json形式存储。详情参见[数据存储](/overview/object.md)文档。
+
+####查询数据
+使用命令`list`查询`Article`类中的所有数据。
+
+```
+Blog Article>list
+{"_id":"f2e88fd91c3a49c988901f774cc9e879","createdAt":1471335596116,"updatedAt":1471335596116,"createdPlat":"admin","updatedPlat":"admin","acl":{"*":{"read":true,"write":true}},"author":"Lucas","title":"StarWars"}
+```
+
+可以看到，现在`Article`类中只有一条刚刚创建的数据。
+
+####表格打印
+使用命令`table`打印`Article`类中的所有数据。
+
+```
+Blog Article>table
+┌──────────────────────────────────┬────────────────────┬────────────────────┐
+│ id                               │ author             │ title              │
+│ <STRING>                         │ <STRING>           │ <STRING>           │
+├──────────────────────────────────┼────────────────────┼────────────────────┤
+│ f2e88fd91c3a49c988901f774cc9e879 │ Lucas              │ StarWars           │
+└──────────────────────────────────┴────────────────────┴────────────────────┘
+```
+
+####删除数据
+使用命令`del id`，删除指定数据，其中 `id` 为刚才查询结果中的id。
+
+```
+Blog Article>del f2e88fd91c3a49c988901f774cc9e879
+Object deleted.
+```
+
+###使用客户端SDK
+我们已经成功创建了应用，构建了数据结构，并存储了一些数据。现在我们可以使用`客户端SDK`、`REST API`存取数据了。详见`客户端SDK`以及`REST API`相关文档。
+
+
+##自定义配置
+###配置文件
+Server目录下的`application.properties`为配置文件。
+
+###MongoDB配置
+在application.properties中配置MongoDB数据库连接信息。
+
+```
+spring.data.mongodb.host = 127.0.0.1 //MongoDB数据库地址 默认为127.0.0.1
+spring.data.mongodb.database = baas //用于存储数据的数据库名称 默认为baas
+spring.data.mongodb.username = baas //用户名 不填写为无身份校验
+spring.data.mongodb.password = baas //密码 不填写为无身份校验
+spring.data.mongodb.authentication-database = admin //用于校验身份的数据库
+```
+
+###Redis配置
+在application.properties中配置Redis数据库连接信息。
+
+```
+spring.redis.host = 127.0.0.1 //Redis数据库地址
+```
+
+###监听端口
+在`application.properties`中配置监听端口，不设置默认为8080。
+
+```
+server.port = 8080
+```
+
+###超级密钥
+超级密钥用于鉴定管理员的超级权限，系统的核心管理接口需要使用此权限进行调用。超级密钥可以自行设置，建议使用32位随机字符串。如：`c3ca79cca3c24147902c1114640268a5`。
+
+在`application.properties`中配置超级密钥，不设置默认为JavaBaas。
+
+注意: 为了保障数据安全，强烈建议不要使用默认密钥！
+
+```
+baas.auth.key = c3ca79cca3c24147902c1114640268a5
+```
+
+###服务器地址
+JavaBaas需要接收外部系统回调请求，因此需要配置系统部署服务器的ip地址。（本地测试时可使用127.0.0.1代替，生产环境需配置公网ip地址。）
+
+例如，在`application.properties`中配置当前服务器ip信息。
+
+```
+host = http://58.132.171.126/
+```
+
+###七牛云存储
+为了使用七牛云存储作为物理文件存储引擎，需要配置七牛云存储相关信息。
+在`application.properties`中配置以下信息。
+
+```
+qiniu.ak = 七牛云存储的帐号ak
+qiniu.sk = 七牛云存储的帐号sk
+qiniu.bucket = bucket名称
+qiniu.file.host = bucket的存储域名
+```
+
+##常见问题

pom.xml

@@ -3,8 +3,8 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>com.staryet</groupId>
-    <artifactId>baas</artifactId>
+    <groupId>com.javabaas</groupId>
+    <artifactId>JavaBaas</artifactId>
     <version>1.0.0</version>
     <packaging>jar</packaging>
 
@@ -14,22 +14,17 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>1.3.2.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
     </parent>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <start-class>com.staryet.baas.Main</start-class>
+        <start-class>com.javabaas.server.Main</start-class>
         <java.version>1.8</java.version>
-        <docker.image.prefix>staryet</docker.image.prefix>
+        <docker.image.prefix>javabaas</docker.image.prefix>
     </properties>
 
     <dependencies>
-        <dependency>
-            <groupId>org.mongodb</groupId>
-            <artifactId>mongo-java-driver</artifactId>
-            <version>3.1.0</version>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>

src/main/java/com/staryet/baas/Main.java → src/main/java/com/javabaas/server/Main.java

@@ -1,9 +1,9 @@
-package com.staryet.baas;
+package com.javabaas.server;
 
-import com.staryet.baas.common.interceptor.AdminInterceptor;
-import com.staryet.baas.common.interceptor.AuthInterceptor;
-import com.staryet.baas.common.interceptor.HeaderInterceptor;
-import com.staryet.baas.common.interceptor.MasterInterceptor;
+import com.javabaas.server.common.interceptor.AdminInterceptor;
+import com.javabaas.server.common.interceptor.AuthInterceptor;
+import com.javabaas.server.common.interceptor.HeaderInterceptor;
+import com.javabaas.server.common.interceptor.MasterInterceptor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

src/main/java/com/staryet/baas/admin/controller/ApiStatController.java → src/main/java/com/javabaas/server/admin/controller/ApiStatController.java

@@ -1,8 +1,8 @@
-package com.staryet.baas.admin.controller;
+package com.javabaas.server.admin.controller;
 
-import com.staryet.baas.admin.entity.ApiMethod;
-import com.staryet.baas.admin.entity.ClientPlatform;
-import com.staryet.baas.admin.service.StatService;
+import com.javabaas.server.admin.entity.ApiMethod;
+import com.javabaas.server.admin.entity.ClientPlatform;
+import com.javabaas.server.admin.service.StatService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;