README.md · noear/water

<h1 align="center" style="text-align:center;">
  Water
</h1>
<p align="center">
一站式分布式服务治理中台。简单工作，早点下班
</p>
<p align="center">
    <a target="_blank" href="https://search.maven.org/search?q=org.noear%20water">
        <img src="https://img.shields.io/maven-central/v/org.noear/water.client.svg?label=Maven%20Central" alt="Maven" />
    </a>
    <a target="_blank" href="LICENSE">
		<img src="https://img.shields.io/:license-LGPL2.1-blue.svg" alt="LGPL2.1" />
	</a>
    <a target="_blank" href="https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html">
		<img src="https://img.shields.io/badge/JDK-8+-green.svg" alt="jdk-8+" />
	</a>
    <br />
    <a target="_blank" href='https://gitee.com/noear/water/stargazers'>
		<img src='https://gitee.com/noear/water/badge/star.svg' alt='gitee star'/>
	</a>
    <a target="_blank" href='https://github.com/noear/water/stargazers'>
		<img src="https://img.shields.io/github/stars/noear/water.svg?logo=github" alt="github star"/>
	</a>
</p>
<br/>
<p align="center">
	<a href="https://jq.qq.com/?_wv=1027&k=6hGHvT1l">
	<img src="https://img.shields.io/badge/QQ交流群-1410383-orange"/></a>
</p>

## 介绍（水孕育万物...）

为Java服务开发和治理，提供一站式解决方案（可以理解为微服务架构支持套件）。基于 Solon 框架开发，并支持完整的 Solon Cloud 规范；已在生产环境跑了4年。

功能相当于：consul + rabbitmq + elk + prometheus + openFaas + quartz + 等等，并有机结合在一起。 或者约等于：nacos + rocketmq + PlumeLog + prometheus + magic-api + xxl-job + 等。

对 k8s 友好，支持 ip 漂移、支持 k8s svc 映射（通过上游配置，可真接将服务发现为 k8s service 地址）。

## 开始

### 了解框架与构件

| 组件                          | 说明                                          |
|-----------------------------|---------------------------------------------|
| org.noear:water.client      | 框架：Water 客户端                                |
| org.noear:water-solon-cloud-plugin | 框架：Water 客户端 for solon（也可用于 Spring Boot 项目） |
|                             |                                             |
| org.noear:waterapi          | 构建：Water 服务端                                |
| org.noear:watersev          | 构建：Water 后台服务（健康检测；数据监视；消息派发；定时任务等...）      |
| org.noear:wateradmin        | 构建：Water 控制台（支持LDAP登录）                      |
| org.noear:waterfaas         | 构建：Water FaaS 服务，提供轻量级FaaS服务                |
|                             |                                             |
| org.noear:xwater         | 构建：Water 助理工具                               |

### 控制台演示站

地址： [http://water.noear.org](http://water.noear.org)  （账号：demo ；密码：demo ）

关键持久化说明：

* 日志持久化，支持：MySql、PostgreSQL、MongoDb、ElasticSearch、ClickHouse
* 消息持久化，支持：MySql、PostgreSQL、MongoDb

### 应用参考

地址：[https://gitee.com/noear/marsh](https://gitee.com/noear/marsh)

### 视频教程

[[Water 教程一] 用 docker-compose 快速部署。轻松工作，早点下班哦：）](https://www.bilibili.com/video/BV1T44y1e7AS/)

[[Water 教程二] 使用 Solon Coud + Water 开发之初体验](https://www.bilibili.com/video/BV1Xr4y1C76M/)

[[Water 教程三] Water 是个一站式的服务治理平台，认识一下](https://www.bilibili.com/video/BV1KQ4y1U7ef/)

[[Water 教程四] 配置服务应用及关键设计](https://www.bilibili.com/video/BV1tY411x7ja/)

[[Water 教程五] 日志服务应用及轻小快的客户端设计](https://www.bilibili.com/video/BV1H44y1v7ES/)

[[Water 教程六] 消息总线服务应用及内部架构设计概要](https://www.bilibili.com/video/bv1mM4y1A7kn/)

[[Water 教程七] FaaS应用实战](https://www.bilibili.com/video/BV1eP4y1G7u2/)

[Water 教程八] 服务监控与数剧监视实战

[Water 教程九] 多账号管理及权限配置，还有LDAP登录配置

[[Water 教程++] 基于源码的部署与运行](https://www.bilibili.com/video/BV1oz4y1F7Q4/)

### (一) 使用

#### 配置
* pom.xml / mevan 配置
```xml

<dependency>
    <groupId>org.noear</groupId>
    <artifactId>water.client</artifactId>
    <version>2.14.2</version>
</dependency>

<dependency>
    <groupId>org.noear</groupId>
    <artifactId>water-solon-cloud-plugin</artifactId>
    <version>2.6.0</version>
</dependency>
```

* app.yml / 配置说明
```yml
solon.app:
  name: "wateradmin"
  group: "water"

solon.cloud.water:
  server: "waterapi:9371"           #WATER服务地址
  config:
    load: "test.yml"                #默认加载的配置
  log:
    default: "water_log_admin"      #默认日志记录器
```

#### 代码
```java
public class DemoApp {
    public void main(String[] args) {
        SolonApp app = Solon.start(DemoApp.class, args);

//监控服务：之：添加接口性能记录（一般这个过滤器写成独立类）
        Logger log = LoggerFactory.getLogger(DemoApp.class);
        app.filter((ctx, chain) -> {
            //1.开始计时（用于计算响应时长）
            long start = System.currentTimeMillis();

try {
                chain.doFilter(ctx);
            } catch (Throwable e) {
                //2.顺带记录个异常
                log.error("{}",e);
            } finally {
                //3.获得接口响应时长
                long milliseconds = System.currentTimeMillis() - start;
                CloudClient.metric().addMeter(Solon.cfg().appName(), "path", ctx.pathNew(), milliseconds);
            }
        });
    }
}

@Configuration
public class DemoConfig {

@Bean
    public DataSource db1(@CloudConfig("demoDb") HikariDataSource ds) {
        //配置一个数据源
        return ds;
    }
    
    @Bean
    public I18nBundleFactory i18nBundleFactory(){
        //将国际化服务，切换为云端接口
        return new CloudI18nBundleFactory();
    }
}

@Slf4j
@Controller
public class DemoController{
    @CloudConfig(name = "demoDb", autoRefreshed = true)  //配置服务的功能（注解模式）
    DbContext demoDb;

@NamiClient            //RPC服务发现的功能（注解模式）
    RockService rockService;
   
    @Mapping("/")
    public void test(){
        //日志服务：写个日志
        log.info("你好，日志服务"); //(content)
        TagsMDC.tag0("demo");
        log.error("{}\r\n{}","test","你好，日志服务"); //(tag,summary,content)
        
        //配置服务：使用配置的数据库上下文进行查询
        Map map = demoDb.table("water_reg_service").limit(1).selectMap("*");

//消息服务：发送消息
        CloudClient.event().publish(new Event("demo.test", "{\"order_id\":1}")); //（非注解模式）

//Rpc发现服务：调用Rpc接口
        AppModel app = rockService.getAppById(12);
    }
}

//消息订阅：订阅消息并处理（根据：topic 进行订阅）
@Slf4j
@CloudEvent("demo.test")
public class Event_demo_test implements CloudEventHandler {
    @Override
    public boolean handle(Event event) throws Exception {
        //处理消息...
        log.info("我收到消息：" + event.content());
        return true;
    }
}

//配置订阅：关注配置的实时更新
@CloudConfig("demoDb")
public class TestConfigHandler implements CloudConfigHandler {
    @Override
    public void handle(Config config) {

}
}

//分布式任务
@CloudJob(name = "demo_test", cron7x = "0 1 * * * ?")
public class Job_test implements CloudJobHandler {

@Override
    public void handle(Context ctx) throws Throwable {
        //处理任务...
        log.info("我被调度了");
    }
}

```

### （二）代码演示

[https://gitee.com/noear/water-examples](https://gitee.com/noear/water-examples)

### （三）部署

具体参考： [_deploy](_deploy)

# 管理界面预览

* 告警专用客户端
<img src="https://gitee.com/noear/water/raw/master/preview/a0.jpg" height="300"/>

* 告警工具
<img src="https://gitee.com/noear/water/raw/master/preview/a1.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/a2.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/a3.png" height="300"/>

* 日志查询
<img src="https://gitee.com/noear/water/raw/master/preview/b1.png" height="300"/>

* 消息总线
<img src="https://gitee.com/noear/water/raw/master/preview/c1.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/c2.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/c3.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/c4.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/c5.png" height="300"/>

* 服务监控
<img src="https://gitee.com/noear/water/raw/master/preview/d2.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d4.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d5.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d6.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d7.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d7x.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/d8.png" height="300"/>

* 配置管理
<img src="https://gitee.com/noear/water/raw/master/preview/e1.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/e3.png" height="300"/>

* 函数计算
<img src="https://gitee.com/noear/water/raw/master/preview/f1.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/f2.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/f5.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/fx.png" height="300"/>

* 开发助手
<img src="https://gitee.com/noear/water/raw/master/preview/h1.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/h2.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/h3.png" height="300"/>
<img src="https://gitee.com/noear/water/raw/master/preview/h4.png" height="300"/>

noear/water

About

Releases (44)

Contributors

Activities

noear/water .gitee-modal { width: 500px !important; }

About

Releases (44)

The Open Source Evaluation Index is derived from the OSS Compass evaluation system, which evaluates projects around the following three dimensions

Contributors

Activities

Search

noear/water