增加Layer组件Compression (#16)

增加Layer组件Compression
w-sodalite · Jan 24, 2024 · 1625680 · 1625680
1 parent ea61f81
commit 1625680
Show file tree

Hide file tree

Showing 41 changed files with 445 additions and 116 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -40,19 +40,20 @@
 
 - #### Layer
 
-  | 名称                  | 描述           |                使用文档                |
-  |:--------------------|--------------|:----------------------------------:|
-  | `Cors`              | 处理跨域请求       |     [文档](docs/layers/cors.md)      |
-  | `KeepHostHeader`    | 保持原始的Host请求头 |    [文档](docs/matchers/query.md)    |
-  | `PathStrip`         | 从请求路径中删除特定部分 |   [文档](docs/matchers/header.md)    |
-  | `RateLimit`         | 限制请求频率       |    [文档](docs/matchers/host.md)     |
-  | `RewritePath`       | 重写请求的接口地址    |    [文档](docs/matchers/time.md)     |
-  | `SetRequestHeader`  | 设置请求头信息      |    [文档](docs/matchers/path.md)     |
-  | `SetResponseHeader` | 设置响应头信息      |    [文档](docs/matchers/path.md)     |
-  | `XForward`          | 设置XForward信息 |    [文档](docs/matchers/path.md)     |
-  | `ConcurrentcyLimit` | 限制同时处理的请求数量  | [文档](docs/matchers/remote_addr.md) |
-  | `RequestBodyLimit`  | 限制请求体的最大大小   |   [文档](docs/matchers/cookie.md)    |
-  | `SetStatus`         | 设置响应状态码      |    [文档](docs/matchers/time.md)     |
+  | 名称                  | 描述           |                   使用文档                   |
+  |:--------------------|--------------|:----------------------------------------:|
+  | `Cors`              | 处理跨域请求       |        [文档](docs/layers/cors.md)         |
+  | `KeepHostHeader`    | 保持原始的Host请求头 |  [文档](docs/layers/keep_host_header.md)   |
+  | `PathStrip`         | 从请求路径中删除特定部分 |     [文档](docs/layers/path_strip.md)      |
+  | `RateLimit`         | 限制请求频率       |     [文档](docs/layers/rate_limit.md)      |
+  | `RewritePath`       | 重写请求的接口地址    |    [文档](docs/layers/rewrite_path.md)     |
+  | `SetRequestHeader`  | 设置请求头信息      | [文档](docs/layers/set_request_header.md)  |
+  | `SetResponseHeader` | 设置响应头信息      | [文档](docs/layers/set_response_header.md) |
+  | `XForward`          | 设置XForward信息 |      [文档](docs/layers/x_forward.md)      |
+  | `ConcurrentcyLimit` | 限制同时处理的请求数量  |  [文档](docs/layers/concurrency_limit.md)  |
+  | `RequestBodyLimit`  | 限制请求体的大小     | [文档](docs/layers/request_body_limit.md)  |
+  | `SetStatus`         | 设置响应状态码      |     [文档](docs/layers/set_status.md)      |
+  | `Compression`       | 压缩响应包体       |     [文档](docs/layers/compression.md)     |
 
 - #### Service
 

diff --git a/docs/layers/compression.md b/docs/layers/compression.md
@@ -0,0 +1,47 @@
+# Compression
+
+> 用来压缩响应包体
+
+## 参数
+
+| 参数                    |   类型    | 是否必须 |  默认值  | 描述                   |
+|:----------------------|:-------:|:----:|:-----:|:---------------------|
+| gzip                  | `bool`  | `N`  | true  | 支持`gzip`压缩           |
+| deflate               | `bool`  | `N`  | false | 支持`deflate`压缩        |
+| br                    | `bool`  | `N`  | false | 支持`br`压缩             |
+| zstd                  | `bool`  | `N`  | false | 支持`zstd`压缩           |
+| level                 |  `i32`  | `N`  |   5   | 压缩级别，越小压缩率越低，但是速度越快。 |
+| above_size            |  `u16`  | `N`  |  128  | 压缩的最小包体大小            |
+| exclude_content_types | `[str]` | `N`  |       | 指定不需要压缩的content_type |
+
+## 配置示例
+
+- ### 简单配置
+
+  > 不支持配置值，使用默认值。
+
+    ```yaml
+    router:
+      routes:
+        - id: static
+          layers:
+            - Compression
+          service: Static=examples/resources
+    ```
+
+- ### 完整模式
+
+    ```yaml
+    router:
+      routes:
+        - id: static
+          layers:
+            - kind: Compression
+              args:
+                gzip: true
+                deflate: true
+                above_size: 128
+                exclude_content_types:
+                  - application/grpc
+          service: Static=examples/resources
+    ```
diff --git a/examples/static.yaml b/examples/static.yaml
@@ -9,4 +9,11 @@ router:
   routes:
     # 静态文件
     - id: static
+      layers:
+        - kind: Compression
+          args:
+            gzip: true
+            above_size: 32
+            exclude_content_types:
+              - application/json
       service: Static=examples/resources
diff --git a/satex-core/src/config/mod.rs b/satex-core/src/config/mod.rs
@@ -334,11 +334,11 @@ impl Default for Trace {
 
 impl Trace {
     fn default_level() -> Level {
-        Level::DEBUG
+        Level::INFO
     }
 
     fn default_include_headers() -> bool {
-        true
+        false
     }
 
     pub fn level(&self) -> Level {

diff --git a/satex-discovery/src/lb/make/ip_hash.rs b/satex-discovery/src/lb/make/ip_hash.rs
@@ -17,9 +17,9 @@ use satex_core::essential::Essential;
 use satex_core::Error;
 
 use crate::lb::make::MakeLoadBalance;
+use crate::lb::make::{make_load_balance, valid_endpoints};
 use crate::lb::LoadBalance;
 use crate::selector::SortedEndpoint;
-use crate::{__make_load_balance, valid_endpoints};
 
 const DEFAULT_TIMEOUT_SECS: u64 = 1800;
 const DEFAULT_INTERVAL_SECS: u64 = 10;
@@ -133,7 +133,7 @@ impl LoadBalance for IpHashLoadBalance {
     }
 }
 
-__make_load_balance! {
+make_load_balance! {
     IpHash,
     #[serde(
         deserialize_with = "satex_core::serde::tot::as_u64",

diff --git a/satex-discovery/src/lb/make/mod.rs b/satex-discovery/src/lb/make/mod.rs
@@ -22,7 +22,7 @@ make! {
 ///
 #[doc(hidden)]
 #[macro_export]
-macro_rules! __make_load_balance {
+macro_rules! make_load_balance {
     ($name:ident $(,)?) => {
         satex_core::make_impl!(MakeLoadBalance,LoadBalance,$name);
     };
@@ -34,11 +34,11 @@ macro_rules! __make_load_balance {
     };
 }
 
+pub(crate) use make_load_balance;
+
 ///
 /// 内部API
 ///
-#[doc(hidden)]
-#[macro_export]
 macro_rules! valid_endpoints {
     ($endpoints:expr) => {{
         match $endpoints.len() {
@@ -48,6 +48,8 @@ macro_rules! valid_endpoints {
     }};
 }
 
+pub(crate) use valid_endpoints;
+
 #[cfg(test)]
 mod test {
     use std::net::{IpAddr, Ipv4Addr, SocketAddr};

diff --git a/satex-discovery/src/lb/make/random.rs b/satex-discovery/src/lb/make/random.rs
@@ -6,9 +6,9 @@ use satex_core::endpoint::Endpoint;
 use satex_core::essential::Essential;
 use satex_core::Error;
 
+use crate::lb::make::{make_load_balance, valid_endpoints};
 use crate::lb::{LoadBalance, MakeLoadBalance};
 use crate::selector::SortedEndpoint;
-use crate::{__make_load_balance, valid_endpoints};
 
 pub struct RandomLoadBalance;
 
@@ -25,7 +25,7 @@ impl LoadBalance for RandomLoadBalance {
     }
 }
 
-__make_load_balance!(Random);
+make_load_balance!(Random);
 
 fn make(_: Args) -> Result<RandomLoadBalance, Error> {
     Ok(RandomLoadBalance)

diff --git a/satex-discovery/src/lb/make/sequential.rs b/satex-discovery/src/lb/make/sequential.rs
@@ -7,9 +7,9 @@ use satex_core::endpoint::Endpoint;
 use satex_core::essential::Essential;
 use satex_core::Error;
 
+use crate::lb::make::{make_load_balance, valid_endpoints};
 use crate::lb::{LoadBalance, MakeLoadBalance};
 use crate::selector::SortedEndpoint;
-use crate::{__make_load_balance, valid_endpoints};
 
 #[derive(Default)]
 pub struct SequentialLoadBalance {
@@ -30,7 +30,7 @@ impl LoadBalance for SequentialLoadBalance {
     }
 }
 
-__make_load_balance!(Sequential);
+make_load_balance!(Sequential);
 
 fn make(_: Args) -> Result<SequentialLoadBalance, Error> {
     Ok(SequentialLoadBalance::default())