# water
**Repository Path**: ApeCoder/water
## Basic Information
- **Project Name**: water
- **Description**: No description available
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 102
- **Created**: 2021-01-29
- **Last Updated**: 2021-01-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://search.maven.org/search?q=g:org.noear%20AND%20water)
` QQ交流群：22200020 `
# Water for java （水孕育万物...）
为中小量级项目，提供服务开发和治理的整体解决方案（可以理解为微服务架构套件）。
## 开始
### 了解框架与构件
| 组件 | 说明 |
| --- | --- |
| org.noear:water.client | 框架：Water 客户端 |
| org.noear:water.client-solon-plugin | 框架：Water 客户端 for solon |
| org.noear:water.client-springboot-starter | 框架：Water 客户端 for springboot 2.x.x |
| | |
| org.noear:waterapi | 构建：Water 服务端 |
| org.noear:watersev | 构建：Water 后台服务（消息派发；定时任务；服务检测...） |
| org.noear:wateradmin | 构建：Water 控制台 |
| org.noear:waterpaas | 构建：Water PaaS 服务，提供轻量级接口服务 |
| org.noear:waterraas | 构建：Water RaaS 服务，提供轻量级规则计算服务 |
### (一) 使用
#### 配置
* pom.xml / mevan 配置
```xml
org.noear
water.client-solon-plugin
2.0.16
```
* application.yml / 配置说明
```yaml
water:
host: "water" #WATER服务地址
logger: "water_log_api" #默认的日志书写器（将Slf4f的日是志转发到这上来）
service: #当前服务配置
tag: "water" #当前服务标签（可以理解为服务组，或业务线技术代号）
name: "wateradmin" #当前服务名称
hostname: "api.water.io" #当前服务主机地址（一般设为外网地址；用于订阅业务消息用）
#hostname: "@water/water_api_host" #如果域名会变，可通过配置指定（@开头，表示从water配置服务获取）
secretKey: "r6rSehL8E9fcEgeA" #当前服务接收消息时的签名密钥
alarm: "18611112222" #当前服务出问题时的告警手机号
config: "@water/*" #当前服务默认加载的配置（@开头，表示从water配置服务获取；会同步到Solon.cfg()）
```
#### 代码
```java
public class DemoApp{
public void main(String[] args){
Solon app = Solon.start(args);
//监控服务：之：添加接口性能记录
app.before("**",XMethod.HTTP,-1,(c)->{
c.attrSet("_timecount", new Timecount().start());
});
app.after("**", XMethod.HTTP,(c)->{
Timecount timecount = c.attr("_timecount", null);
if (timecount == null || c.status() == 404) {
return;
}
String node = WaterAdapter.global().localHost();
long times = timecount.stop().milliseconds();
WaterClient.Track.track("water-demo", "path", c.path(), times, node);
});
}
}
@Controller
class demo{
@Water("water_log_api") //日志服务的功能（注解模式）
WaterLogger log;
@Water("water/water") //配置服务的功能（注解模式）
DbContext waterDb;
@Water //RPC服务发现的功能（注解模式）
RockRpc rock;
@Mapping("/")
public void test(){
//日志服务：写个日志
log.info("你好，日志服务"); //(content)
log.error("demo","test","你好，日志服务"); //(tag,summary,content)
WaterClient.Log.append("water_log_api",Level.info,"你好,世界!");//（非注解模式）
//配置服务：使用配置的数据库上下文进行查询
var map = waterDb.table("bcf_user").limit(1).select("*").getMap();
WaterClient.Config.getByTagKey("water/water").getDb().table("bcf_user").select("*").getMap();//（非注解模式）
//消息服务：发送消息
WaterClient.Messsage.sendMessage("test.order.start", "{\"order_id\":1}"); //（非注解模式）
//PaaS服务：调用PaaS接口
WaterProxy.paas("water/test",null);
//Rpc发现服务：调用Rpc接口
AppModel app = rock.getAppById(12);
WaterUpstream.client(RockRpc.class).getAppById(12); //非注解模式
}
}
//消息订阅：订阅消息并处理（根据：topic 进行订阅）
@WaterMessage("test.order.end")
public class msg_updatecache implements MessageHandler {
@Override
public boolean handler(MessageM msg) throws Exception {
//处理消息...
}
}
//配置订阅：关注配置的实时更新（根据：tag 进行订阅）
@WaterConfig("water")
public class TestConfigHandler implements ConfigHandler {
@Override
public void handler(ConfigSetM cfgSet) {
}
}
```
### （二）演示代码
[https://gitee.com/noear/water_demo](https://gitee.com/noear/water_demo)
### （三）部署
> 相关材料未准备好...
### （四）架构说明
> 相关材料未准备好...
# 管理界面预览
* 报警专用客户端
* 管理小工具
* 日志查询
* 消息中心管理
* 服务监控
* 配置管理
* PaaS管理后台
* 开发者小工具
