Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
allwefantasy committed Mar 21, 2014
1 parent c28aa71 commit 8c3a87f
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 6 deletions.
14 changes: 14 additions & 0 deletions README-EN.md
Expand Up @@ -7,6 +7,19 @@ like [ActiveORM](https://github.com/allwefantasy/active_orm) and [MongoMongo](ht
written by java language according to the Model-View-Controller(MVC) pattern.


### How to use ServiceFramework in Maven

add Dependency in your pom.xml:

<dependency>
<groupId>net.csdn</groupId>
<artifactId>ServiceFramework</artifactId>
<version>1.0</version>
</dependency>

make sure config/application.yml,config/logging.yml are present in your project root.


1. ActiveORM in ServiceFramework like ActiveRecord in Rails,Awesome.


Expand Down Expand Up @@ -170,6 +183,7 @@ used.




## Tutorial Usefull


Expand Down
20 changes: 16 additions & 4 deletions README.md
Expand Up @@ -2,12 +2,21 @@

[README-EN](https://github.com/allwefantasy/ServiceFramework/blob/master/README-EN.md)

![logo](http://allwefantasy.com/service_framework_logo_big.jpg)

ServcieFramework 定位在 **移动互联网后端** 领域,强调开发的高效性,其开发效率可以比肩Rails.

注: 目前项目已经使用Maven进行了管理,但是部分jar包只能从公司内部仓库访问到(这些jar包的源码也都是开源的)。所以使用
时可直接使用lib目录下的jar即可。
### 在Maven中使用该项目

在你的pom.xml 文件中中添加如下引用:

<dependency>
<groupId>net.csdn</groupId>
<artifactId>ServiceFramework</artifactId>
<version>1.0</version>
</dependency>



接着确保 项目根目录下有config/application.yml,config/logging.yml 两个文件即可。示例可参看该项目中config文件夹。

1. ActiveRecord化的Model层,支持 MongoDB 和 MySQL.

Expand Down Expand Up @@ -186,6 +195,9 @@ QuickStart 的一些常见错误:






Model层基于如下开源项目:

* [ActiveORM](https://github.com/allwefantasy/active_orm)
Expand Down
32 changes: 30 additions & 2 deletions doc/ServiceFrameworkWiki-config.md
Expand Up @@ -49,6 +49,7 @@ development:
database: tag_engine
username: tag
password: tag
disable: true
mongodb:
host: 127.0.0.1
port: 27017
Expand Down Expand Up @@ -82,7 +83,7 @@ orm:
idle_test_period: 3000
###############application config##################
application:
controller: com.example.controller
controller: com.example.controller
model: com.example.model
service: com.example.service
util: com.example.util
Expand Down Expand Up @@ -113,4 +114,31 @@ 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的配置就是数据库配置类的扫描路径配置。


2 changes: 2 additions & 0 deletions doc/ServiceFrameworkWiki-test.md
Expand Up @@ -100,6 +100,8 @@ Service层的测试:

这个时候,searchService中的transportService就会呗你的Mock对象所替代,该对象你可以直接继承TransportService 类。




0 comments on commit 8c3a87f

Please sign in to comment.