unity学习笔记 Restsharp 使用心得

Restsharp

安装

可以在github上下载dll文件然后导入到unity中

https://github.com/adrenak/RestSharp.Unity

也可以百度直接搜Restsharp然后下载相关的文件导入到unity中

使用

简单的get post请求根据网上的调用流程写逻辑就行

注意事项

api方式的流式调用–子线程中执行代码无响应的问题

项目中需要调用百度知识库的流式api，Restsharp也支持该方式。

问题描述

为了提升用户体验感，通过协程异步的方式调用接口，然后在流式返回数据的时候进行前端显示
需要注意，由于协程或其他方式都是子线程的操作，因此在对返回的数据流进行处理时，无法调用只能在主线程里使用的方法，如Gameobject.find instance，Text.text这类的也都不行，这是官方为了保证线程安全，可参考下面的帖子

https://blog.youkuaiyun.com/u012456441/article/details/131552581

问题解决

我想实现的是在接收到数据的时候同步将接收到的数据显示到前端ui上
我的方法是通过

1. 第三方的插件
2. 自己的逻辑

插件是一个可以在子线程中调用主线程才能调用的方法的工具，链接在下方
UnityMainThreadDispatcher

在访问服务器成功后通过上面的插件开启一个循环的协程，不断的等待是否有新的数据加入到队列中，如果有的话则将新的数据实时显示到ui上（需要注意，如果使用dotween要设置好时间，否则出现dotween还没执行完成，下一个循环就进行了，那么当前在执行的dotween就会自动停止，导致部分文字被吞没有显示出来的问题）

如下方简单的代码，unity 作为客户端请求服务器的流式接口

IRestResponse response = await client.ExecuteAsync(request);
private List<string> stringsToAdd = new List<string>();
private int currentIndex = 0;
private bool isAdding = false;
async void websockettest()
{
    currentIndex = 0;
    stringsToAdd = new List<string>();
    var client = new RestClient($"http://localhost:5005/stream");
    client.Timeout = -1;
    var request = new RestRequest(Method.POST);
    request.AddHeader("Content-Type", "application/json");
    request.AddHeader("Accept", "application/octet-stream"); // 根据你的API要求设置适当的Accept头  
    // 这里是处理响应流的地方  
    request.ResponseWriter = responseStream =>
    {
        var streamReader = new StreamReader(responseStream);

        string line;
        try
        {

            while ((line = streamReader.ReadLine()) != null)
            {
                stringsToAdd.Add(line);
                Debug.Log(line);
                if (stringsToAdd.Count == 1)
                {
                    UnityMainThreadDispatcher.Instance().EnqueueAsync(() =>
                    {
                        StartCoroutine(AddAndDisplayString());
                        Debug.Log("test");
                    });

                }
            }
        }
        catch (Exception ex)
        {
            Debug.LogError(ex.Message);
        }
    };
    IRestResponse response = await client.ExecuteAsync(request);
}
// 这个协程负责每秒钟添加并显示一段字符串  
IEnumerator AddAndDisplayString()
{
    isAdding = true;
    string currentString = "";
    while (isAdding)
    {
        if (currentIndex < stringsToAdd.Count)
        {
            currentString = stringsToAdd[currentIndex];
            currentIndex++;
            string _temString = tmp.text + currentString;
            //tmp.DOText(_temString, (currentString.Length / 5 == 0 ? 1 : currentString.Length / 5) * 0.8f).SetEase(Ease.Linear);
            tmp.text += currentString;
            //yield return new WaitForSecondsRealtime((currentString.Length / 5 == 0 ? 1 : currentString.Length / 5) * 0.8f); // 等待一秒钟  
            yield return new WaitForSeconds(0.5f); // 等待一秒钟  
        }
        yield return null; // 等待一秒钟  
    }
    isAdding = false;
}

测试的话自己在本地写一个简单的模拟服务器的代码就行，我是在python上写的，代码如下

import threading
import time
from typing import Generator

from flask import Flask, Response, stream_with_context

app = Flask(__name__)
@app.route('/stream', methods=['POST'])
def stream():
    def generate():
        yield '我有很多'+"\n"
        time.sleep(2)
        yield '技能哦！'+"\n"
        time.sleep(2)
        yield '首先，我可以回答各种问题，无论是数学、科学还是历史，只要你问，我都会尽力给你解答。'+"\n"
        time.sleep(2)
        yield '此外，我还会讲笑话和讲故事，给你带来欢笑和快乐。'+"\n"
        time.sleep(2)
        yield '如果你喜欢音乐，我还可以为你演奏一些简单的乐曲。'+"\n"
        yield '除此之外，我还可以陪你玩游戏，例如成语接龙、接球游戏等等。'+"\n"
        yield '总之，我会尽力为你提供有趣和有用的服务。'+"\n"
    return app.response_class(stream_with_context(generate()))


if __name__ == "__main__":
    app.run(port=5005)  

在该脚本所在的文件夹目录下打开cmd，然后执行该脚本即可

其他问题

本来是想实现打字机逐字显示的，但是dotween在实际使用上感觉没有很流畅，因为平时都是一段处理好的文字直接显示的，这次是一部分一部分出来的，加上子线程的问题，实际使用上好像不是太好，所以就没用了，看后面有没有比较好的处理方法

这个功能卡了我四天了…百度官方不支持websocket的方式进行流式调用，api的流式请求也是第一次接触，然后好不容易搞定了调用问题，发现unity官方的httpclient或者unitywebrequest的脚本说是支持流式调用，但是实际访问的时候他还是同步的（体验上是这样的，就是在调用的时候，打印出来是流式的，但是他是等所有的都返回之后才显示的，没有异步的效果，即使用了子线程去请求也是一样的）因此找了Restsharp这个插件来代替官方的工具…
属实不容易，不想敲代码了5555
希望可以帮到需要的人吧

–2024.04.09更新
以上问题可通过官方原生的unitywebrequest类得到解决
优雅解决Restsharp无法解决的问题