Dapr在Java中的实践之状态管理

青旅半醒 2023-09-28 12:48 123阅读 0赞

#### 文章目录 ####

*  状态管理
 *  编写示例代码
 *  启动服务
 *  状态储存组件

--------------------

## 状态管理 ##

状态管理（State Management）使用键值对作为存储机制，可以轻松的使长时运行、高可用的有状态服务和无状态服务共同运行在我们的服务中。

我们的服务可以利用Dapr的状态管理API在状态存储组件中保存、读取和查询键值对。

状态存储组件是可插拔的，目前支持使用Azure CosmosDB、 Azure SQL Server、 PostgreSQL,、AWS DynamoDB、Redis 作为状态存储介质。

## 编写示例代码 ##

创建一个SpringBoot项目，命名为：`state-management`，该项目的状态管理调用过程如下图：

![state-management-overview.png][]

在`state-management`该项目的`pom.xml`文件中添加如下依赖：

<dependency>
        <groupId>io.dapr</groupId>
        <artifactId>dapr-sdk-springboot</artifactId>
        <version>1.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.9.3</version>
    </dependency>

注入一个`DaprClient`的bean：

@Configuration
    public class DaprConfig {
        
    
        private static final DaprClientBuilder BUILDER = new DaprClientBuilder();
    
        @Bean
        public DaprClient buildDaprClient() {
        
            return BUILDER.build();
        }
    }

`state-management`项目中一共有3个接口：

*  `save`：保存状态
 *  `get`：读取状态
 *  `delete`：删除状态

具体源码如下：

package one.more.society.state.management;
    
    import io.dapr.client.DaprClient;
    import io.dapr.client.domain.State;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    @Slf4j
    @RestController
    public class StateManagementController {
        
    
        @Autowired
        private DaprClient client;
    
        private static final String STATE_STORE_NAME = "statestore";
        private static final String STATE_STORE_KEY = "one.more.society";
    
        /**
         * 保存状态
         *
         * @param value value
         * @return
         */
        @RequestMapping(value = "/save", method = RequestMethod.GET)
        public StateResponse save(String value) {
        
            log.info("save - value:{}", value);
            client.saveState(STATE_STORE_NAME, STATE_STORE_KEY, value).block();
    
            StateResponse response = new StateResponse();
            response.setCode(1);
            response.setStatus("save");
            response.setValue(value);
            return response;
        }
    
        /**
         * 读取状态
         *
         * @return StateResponse
         */
        @RequestMapping(value = "/get", method = RequestMethod.GET)
        public StateResponse get() {
        
            log.info("get");
            State<String> value = client.getState(STATE_STORE_NAME, STATE_STORE_KEY, String.class).block();
            log.info("value: {}", value.getValue());
    
            StateResponse response = new StateResponse();
            response.setCode(1);
            response.setStatus("get");
            response.setValue(value.getValue());
            return response;
        }
    
        /**
         * 删除状态
         *
         * @return
         */
        @RequestMapping(value = "/delete", method = RequestMethod.GET)
        public StateResponse delete() {
        
            log.info("delete");
            client.deleteState(STATE_STORE_NAME, STATE_STORE_KEY).block();
    
            StateResponse response = new StateResponse();
            response.setCode(1);
            response.setStatus("delete");
            return response;
        }
    }

另外，在`application.properties`中配置：

server.port=30003

## 启动服务 ##

在启动之前先用`mvn`命令打包：

mvn clean package

在`state-management`项目的目录中执行以下命令，启动`state-management`服务：

dapr run --app-id state-management --app-port 30003 --dapr-http-port 31003 -- java -jar target/state-management-0.0.1-SNAPSHOT.jar

在Dapr Dashboard中看到：

![Dapr Dashboard][]

服务都已经启动成功。

先访问[http://localhost:30003/get][http_localhost_30003_get]，可以看到：

![0e34e2bd6c75a312eb44db83758ef3f8.png][]

读取状态返回为null，接下来访问[http://localhost:30003/save?value=万猫学社][http_localhost_30003_save_value]，可以看到：

![9f9c1b2f4d8ebeee9eede1ce63b90c69.png][]

状态已经保存了，再访问[http://localhost:30003/get][http_localhost_30003_get]验证一下：

![2079cdb3999871d5e079217a57b90a63.png][]

状态被正确读取，再访问[http://localhost:30003/delete][http_localhost_30003_delete]，可以看到：

![b6b4e256f92301e7cb2a1ed0a1ec7583.png][]

状态已经被删除了，再访问[http://localhost:30003/get][http_localhost_30003_get]验证一下：

![c63f4a3e70e702c8a4bf1894c1c634fb.png][]

读取状态返回为null。

## 状态储存组件 ##

初始化Dapr后，默认为我们指定的状态储存组件是Redis，在用户目录下的`.dapr`文件夹中的`components`文件夹中，可以找到`statestore.yaml`文件：

apiVersion: dapr.io/v1alpha1
    kind: Component
    metadata:
      name: statestore
    spec:
      type: state.redis
      version: v1
      metadata:
      - name: redisHost
        value: localhost:6379
      - name: redisPassword
        value: ""
      - name: actorStateStore
        value: "true"

下面让我们来尝试一下，使用MySQL作为状态储存组件，把`statestore.yaml`文件修改为：

重新启动服务，可以看到在日志中看到使用MySQL作为状态储存组件：

time="09:57:35.5632633+08:00" level=info msg="Creating MySql schema 'dapr_state_store'" app_id=state-management instance=JT-243137 scope=dapr.contrib type=log ver=1.7.3
    time="09:57:35.5862126+08:00" level=info msg="Creating MySql state table 'state'" app_id=state-management instance=JT-243137 scope=dapr.contrib type=log ver=1.7.3
    time="09:57:35.6563599+08:00" level=info msg="component loaded. name: statestore, type: state.mysql/v1" app_id=state-management instance=JT-243137 scope=dapr.runtime type=log ver=1.7.3

如果在MySQL中没有对应的库和表，Dapr默认为我们自动创建一个名为`dapr_state_store`的库，还有一个名为`state`的表，如下图：

![f24ca35ac65d450cba11defb1e07b42d.png][]

其中，`state`的表结构为：

CREATE TABLE `state` (
      `id` varchar(255) NOT NULL,
      `value` json NOT NULL,
      `isbinary` tinyint(1) NOT NULL,
      `insertDate` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
      `updateDate` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
      `eTag` varchar(36) NOT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

再访问一下[http://localhost:30003/save?value=万猫学社][http_localhost_30003_save_value]，就可以在数据库中看到对应的数据：

![5223e9e64e8601e5a07ee90ba110d042.png][]

值得注意的是：**MySQL状态储存组件目前还处于Alpha状态，最好不要在生产环境使用。**

更详细的配置说明见下表：

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>是否必填</th> 
   <th>说明</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>connectionString</td> 
   <td>Y</td> 
   <td>用于连接到 MySQL 的连接字符串。 请不要将schema添加到连接字符串中。</td> 
   <td>非SSL连接: <br><code>"&lt;user&gt;:&lt;password&gt;@tcp(&lt;server&gt;:3306)/?allowNativePasswords=true"</code> <br> Enforced SSL 连接: <br><code>"&lt;user&gt;:&lt;password&gt;@tcp(&lt;server&gt;:3306)/?allowNativePasswords=true&amp;tls=custom"</code></td> 
  </tr> 
  <tr> 
   <td>schemaName</td> 
   <td>N</td> 
   <td>要使用的schema名称。 如果指定的schema不存在，将会自动创建。默认值为<code>"dapr_state_store"</code></td> 
   <td><code>"one_more_state_store"</code></td> 
  </tr> 
  <tr> 
   <td>tableName</td> 
   <td>N</td> 
   <td>要使用的表名。如果对应的表不存在，将被自动创建。默认值为 “state”</td> 
   <td><code>"one_more_state"</code></td> 
  </tr> 
  <tr> 
   <td>pemPath</td> 
   <td>N</td> 
   <td>使用 Enforced SSL 连接 时，指定要使用的 PEM 文件完整路径。</td> 
   <td>“/one/more/society/file.pem”</td> 
  </tr> 
  <tr> 
   <td>pemContents</td> 
   <td>N</td> 
   <td>如果没有提供pemPath，用于Enforced SSL连接的PEM文件的内容。可以在K8s环境下使用。</td> 
   <td>“pem value”</td> 
  </tr> 
 </tbody> 
</table>

配置示例：

apiVersion: dapr.io/v1alpha1
    kind: Component
    metadata:
      name: statestore
    spec:
      type: state.mysql
      version: v1
      metadata:
      - name: connectionString
        value: "root:one.more.society@tcp(127.0.0.1:3306)/?allowNativePasswords=true&tls=custom"
      - name: schemaName
        value: "one_more_state_store"
      - name: tableName
        value: "one_more_state"
      - name: pemPath
        value: "/one/more/society/file.pem"

> 最后，感谢你这么帅，还给我**点赞**。

[state-management-overview.png]: https://img-blog.csdnimg.cn/img_convert/7f345270460e9e5ffd2a6beb4b252a3e.png
[Dapr Dashboard]: https://img-blog.csdnimg.cn/img_convert/60047273c0fde3dffc7676435fbdfcc3.png
[http_localhost_30003_get]: http://localhost:30003/get
[0e34e2bd6c75a312eb44db83758ef3f8.png]: https://img-blog.csdnimg.cn/img_convert/0e34e2bd6c75a312eb44db83758ef3f8.png
[http_localhost_30003_save_value]: http://localhost:30003/save?value=%E4%B8%87%E7%8C%AB%E5%AD%A6%E7%A4%BE
[9f9c1b2f4d8ebeee9eede1ce63b90c69.png]: https://img-blog.csdnimg.cn/img_convert/9f9c1b2f4d8ebeee9eede1ce63b90c69.png
[2079cdb3999871d5e079217a57b90a63.png]: https://img-blog.csdnimg.cn/img_convert/2079cdb3999871d5e079217a57b90a63.png
[http_localhost_30003_delete]: http://localhost:30003/delete
[b6b4e256f92301e7cb2a1ed0a1ec7583.png]: https://img-blog.csdnimg.cn/img_convert/b6b4e256f92301e7cb2a1ed0a1ec7583.png
[c63f4a3e70e702c8a4bf1894c1c634fb.png]: https://img-blog.csdnimg.cn/img_convert/c63f4a3e70e702c8a4bf1894c1c634fb.png
[f24ca35ac65d450cba11defb1e07b42d.png]: https://img-blog.csdnimg.cn/img_convert/f24ca35ac65d450cba11defb1e07b42d.png
[5223e9e64e8601e5a07ee90ba110d042.png]: https://img-blog.csdnimg.cn/img_convert/5223e9e64e8601e5a07ee90ba110d042.png