更新文档

allwefantasy · allwefantasy · commit 4db4756cef37 · 2015-10-18T19:20:57.000+08:00
diff --git a/README.md b/README.md
@@ -4,18 +4,16 @@
 
 ServcieFramework 定位在 **移动互联网后端** 领域,强调开发的高效性，其开发效率可以比肩Rails.
 
-现在代码中的pom文件用的是公司的maven仓库。更目录下有个open-source.xml，修改成pom.xml即可正常编译。
-### 在Maven中使用该项目
+ServcieFramework 目前更新频率较高,我现在一直疏于更新中央仓库的版本。所以Wiki中不再提供Maven版本。
 
-在你的pom.xml 文件中中添加如下引用:
+建议：
 
-        <dependency>
-            <groupId>net.csdn</groupId>
-            <artifactId>ServiceFramework</artifactId>
-            <version>1.1</version>
-        </dependency>
+1. 下载 https://github.com/allwefantasy/csdn_common，并且deploy自己的私有maven仓库.
+2. 下载ServiceFramework 通过maven deploy到自己的maven仓库。
 
+现在代码中的pom文件用的是自己公司的maven仓库。根目录下有个open-source.xml，修改成pom.xml即可正常编译。
 
+### 在Maven中使用该项目
 
 接着确保 项目根目录下有config/application.yml,config/logging.yml 两个文件即可。示例可参看该项目中config文件夹。
 
@@ -88,7 +86,41 @@ ServiceFramework 特点：
 
         服务提供者可以针对一个http接口定义出任意个方法，每个方法都之定义一部分参数，这样可以有效方便调用者使用。
 
+7. 如果你不使用Dubbo，你可以可以非常容易的调用第三方的标准HTTP接口，达到类似RPC调用的效果。
 
+   * 将第三方HTTP API 做个申明，例如有个搜索接口(Scala代码示例)
+   
+		   trait SearcherClient {
+		  @At(path = Array("/v2/~/~/_search"), types = Array(GET, POST))
+		  @BasicInfo(
+		    desc = "索引服务",
+		    state = State.alpha,
+		    testParams = "",
+		    testResult = "",
+		    author = "WilliamZhu",
+		    email = "allwefantasy@gmail.com"
+		  )
+		  def search(params: Map[String, String], content: String, method: net.csdn.modules.http.RestRequest.Method): java.util.List[HttpTransportService.SResponse]
+		
+		}
+
+    * 接着在需要使用该接口的地方调用如下代码构建SearcherClient对象。记住，这个对象只能构建一次(Scala代码示例)
+    
+		   val _searchClient = AggregateRestClient.buildClient[SearcherClient](hostAndPorts, new SearchEngineStrategy(), httpRequest)
+		   //其中，hostAndPorts 为域名和端口。
+		   //可以是多个。SearchEngineStrategy 是自定义实现如何调用后端服务，
+		   //是轮训的负载均衡还是有特别的逻辑
+ 
+    
+    * 现在可以使用了(Scala代码示例)
+    
+		    val res = _searchClient.search(
+		        url._2.toMap ++ Map("index" -> index, "type" -> ctype),
+		        query,
+		        RestRequest.Method.POST).searchResult
+    
+    使用该种方式调用第三方API会产生Trace日志。
+    
 7. 服务降级限流
 ServiceFramework主要面向后端服务，如果没有自我保护机制，系统很容易过载而不可用。经过一定的容量规划，或者通过对接口调用平均响应耗时的监控，
 我们可以动态调整 ServiceFramework 的QPS限制，从而达到保护系统的目的。这些都可以通过配置以及内置的http接口完成。
diff --git a/ServiceFrameworkWiki-config.md b/ServiceFrameworkWiki-config.md
@@ -0,0 +1,144 @@
+<link rel="stylesheet" href="http://yandex.st/highlightjs/6.2/styles/googlecode.min.css">
+
+<script src="http://code.jquery.com/jquery-1.7.2.min.js"></script>
+<script src="http://yandex.st/highlightjs/6.2/highlight.min.js"></script>
+
+<script>hljs.initHighlightingOnLoad();</script>
+
+
+<script type="text/javascript">
+ $(document).ready(function(){
+      $("h2,h3,h4,h5,h6").each(function(i,item){
+          $(item).attr("id","wow"+i);
+          $("#category").append("<li><a href=\"#wow"+i+"\">"+$(this).text()+"</a></li>");
+      });     
+ });
+</script> 
+
+
+
+<style>
+pre code {
+  break-word: break-all;
+  word-wrap: break-word;
+}
+</style>
+
+#ServiceFramework Wiki
+
+### 配置文件
+
+ServiceFramework 所有的配置文件位于config目录下。其实只有两个配置文件，一个application.yml,
+一个logging.yml.分别配置应用和日志。
+
+一个完整的application.yml
+
+```
+#mode
+mode:
+  development
+#mode=production
+
+###############datasource config##################
+#mysql,mongodb,redis等数据源配置方式
+development:
+    datasources:
+        mysql:
+           host: 127.0.0.1
+           port: 3306
+           database: tag_engine
+           username: tag
+           password: tag
+           disable: true
+        mongodb:
+           host: 127.0.0.1
+           port: 27017
+           database: tag_engine
+        redis:
+            host: 127.0.0.1
+            port: 6379
+
+production:
+    datasources:
+        mysql:
+           host: 127.0.0.1
+           port: 3306
+           database: tag_engine
+           username: tag
+           password: tag
+        mongodb:
+           host: 127.0.0.1
+           port: 27017
+           database: tag_engine
+        redis:
+            host: 127.0.0.1
+            port: 6379
+
+orm:
+    show_sql: true
+    pool_min_size: 5
+    pool_max_size: 10
+    timeout: 300
+    max_statements: 50
+    idle_test_period: 3000
+###############application config##################
+application:
+    controller: com.example.controller  
+    model:      com.example.model
+    service:    com.example.service
+    util:       com.example.util
+    test:       test.com.example
+
+
+###############http config##################
+http:
+    port: 9400
+
+
+
+###############validator config##################
+#如果需要添加验证器，只要配置好类全名即可
+#替换验证器实现，则替换相应的类名即可
+#warning: 自定义验证器实现需要线程安全
+
+validator:
+   format:        net.csdn.validate.impl.Format
+   numericality:  net.csdn.validate.impl.Numericality
+   presence:      net.csdn.validate.impl.Presence
+   uniqueness:    net.csdn.validate.impl.Uniqueness
+   length:        net.csdn.validate.impl.Length
+   associated:    net.csdn.validate.impl.Associated
+
+################ 数据库类型映射 ####################
+type_mapping:  net.csdn.jpa.type.impl.MysqlType
+
+```
+
+对于数据库等的配置默认区分开发，生产，测试。单元测试强制使用测试环境。
+
+除了默认的的一些配置，你可以随意按标准的yaml格式添加配置，在实际代码中，你可以通过下面的方式获取
+配置
+
+首先注入Settings类
+
+      @Inject
+      private Settings settings;
+
+然后就可以如下使用了:
+
+      boolean enable = settings.getAsBoolean("foo.bar.yes",false)
+
+
+在ServiceFramework中，Controller,Service,Util，Model等是需要在配置文件中明确指定的。类似配置如下：
+
+      application:
+          controller: com.example.controller  
+          model:      com.example.model
+          service:    com.example.service
+          util:       com.example.util
+          test:       test.com.example
+
+
+理论上，ServiceFramework的配置就是数据库配置类的扫描路径配置。
+
+
diff --git a/open-source.xml b/open-source.xml
@@ -42,7 +42,7 @@
         <dependency>
             <groupId>net.csdn</groupId>
             <artifactId>csdn-common</artifactId>
-            <version>1.3</version>
+            <version>1.5</version>
         </dependency>
 
         <dependency>
