使用xlua 进行Unity3D 热更新-2

一接触到新的东西,总想看看背后的原理是怎样的,xlua也不例外。于是试着写了一下,算是了解底层的实现原理,以后不用xlua也能有借鉴的地方。

xlua的热修复原理实际上是在 C# 编译成中间语言的时候,进行代码的插入这部分用到了 Mono.Ceil 库来操作,当然还有其他很多的库也可以实现。 因为是在IL的部分插入,因此直接支持IL2CPP

直接进入主题

已知有一个类

public class InputTest{

    void Start(){
        Hello();
    }
    private void Hello(){
        Debug.Log("hello");
        Debug.Log("666"):
    }
}

这个类在被Unity调用的时候会输出 “Hello”
那么如果我们想修改Hello函数该怎么做呢

string injectPath = @"./Library\ScriptAssemblies\Assembly-CSharp.dll";
AssemblyDefinition assemblyDefinition = null;
var readerParameters = new ReaderParameters { ReadSymbols = true };
assemblyDefinition = AssemblyDefinition.ReadAssembly(injectPath, readerParameters);

第一步 是要将当前代码的 Assembly 读出来, U3d有3个Assembly。 一个是项目代码叫 Assembly-CSharp.dll 一个是编辑器代码 Assembly-Editor-CSharp.dll.
还有一个是插件 Assembly-Plugin-CSharp.dll. 因为 InputTest是项目代码部分,所以读取 Assembly-CSharp.dll即可

读取成功后,所有的数据都在 assemblyDefinition 中,只需要遍历一下找到要修改的类即可

 foreach (Mono.Cecil.TypeDefinition item in assemblyDefinition.MainModule.Types) {

                if(item.FullName == "InputTest") {
                    foreach (MethodDefinition method in item.Methods) {

                        if (method.Name.Equals("Hello")) {
                        }
                    }
                }
}

第二步 通过遍历类型定义找到我们的类 “InputTest” 然后在 类定义中遍历所有的函数定义,找到我们要修改的 “Hello”函数
找到函数后,就可以正式做函数修改了。

var ins = method.Body.Instructions.First();
var worker = method.Body.GetILProcessor();
var logRef = assemblyDefinition.MainModule.Import(typeof(Debug).GetMethod("Log", new Type[] { typeof(string) }));

worker.InsertBefore(ins, worker.Create(OpCodes.Ldstr, "Fuck Off"));
worker.InsertBefore(ins, worker.Create(OpCodes.Call, logRef));

worker.InsertBefore(ins, worker.Create(OpCodes.Ldstr, "Fuck On"));
worker.InsertBefore(ins, worker.Create(OpCodes.Call, logRef));

Type type = typeof(InjectTest);

 if (null != type) {
     MethodInfo subMethod = type.GetMethod("SayFuck");

     if (null != subMethod) {
          Debug.Log("Find Method: " + subMethod);

          var sayRef = assemblyDefinition.MainModule.Import(subMethod);

          worker.InsertBefore(ins, worker.Create(OpCodes.Call, sayRef));
      }
}

var writerParameters = new WriterParameters { WriteSymbols = true };
assemblyDefinition.Write(injectPath, new WriterParameters());

第三步 做了3件事情, 绑定了2个UnityEngine的Log函数,打印了 “Fuck Off”, “Fuck On” 之后再绑定一个类 “InjectTest”中的静态函数 SayFuck()
这样原本的 Hello()函数就会在 打印”Hello”之前先打印 “Fuck Off”, “Fuck On” 调用 InjectTest.SayFuck().

最后就是将执行的修改进行保存 assemblyDefinition.Write

最后的最后用C#反编译软件打开 Assembly-CSharp.dll 看看修改后的Hello()函数

可以看到已经成功的修改啦。

使用xlua 进行Unity3D 热更新

之前一直在纠结项目的某些运营界面使用全Lua来写,这样可以热更新上线不同的活动,而不需要上架不同的版本,虽然可以通过资源更新加载xml的方式来实现,但是要通过xml来组合一些新的活动逻辑会很困难.

然后听了很多朋友最近都在推荐xlua, 不但可以做纯lua的逻辑更新,还可以做 C# 代码的bug hotfix.
就是可以在保持项目使用C#逻辑开发的前提下,出现bug后使用lua来修复.听起来很棒棒.

github地址 : xlua

试用一下之后,发现xlua的hotfix原理也很简单, 就是通过反射取出打上了 [hotfix] 标记的类,
然后对需要fix的函数执行下列伪代码

void Start()
{
  if(_hotfix)
   _lua_add(a,b);
  else
   _csharp_add(a,b);
}

那么思路就来了.
设定一个全局 hotfix管理类, 在游戏初始化的时候拉取服务器的 hotfix 版本号, 看看服务器上是否有新的补丁需要下载, 如果有,将补丁存到本地. 之后加载 补丁, 打补丁. 最后进入游戏.

正好以前自己写过好几个lua项目比如 : PrompaLua, lua还没忘记..正好用上 哈哈

首先是一个范例:
一个有bug的类

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;

[Hotfix]
public class FuckYouSelf : MonoBehaviour {

    private int A;
    private int B;

    void Init() {

    }
    // Use this for initialization
    void Start () {
        Init();
        UnityEngine.Debug.Log(Add(A, B));
    }

    int Add(int a, int b) {
        return a - b;
    }
   
    // Update is called once per frame
    void Update () {
       
    }
}

错误有 A,B 没有初始化
Add函数被写成了减法

好在类的开头被打上了 [Hotfix] 标记,让我们有机会热修复他.

然后是HotFix类

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using XLua;


public class HotFix : MonoBehaviour {

    public GameObject StartUp;

    [Serializable]
    struct VersionData {
        public string Version;
        public string FixUrl;
    }

    LuaEnv luaevn = new LuaEnv();
    // Use this for initialization
    void Awake () {

        StartCoroutine(LoadVersion("http://www.dreamfairy.cn/xlua/test/version.txt"));
    }

    IEnumerator LoadVersion(string versionUrl) {
        WWW versionData = new WWW(versionUrl);

        yield return versionData;

        if(null != versionData.error) {
            Debug.LogError(versionData.error);
        } else {
            VersionData data = JsonUtility.FromJson<VersionData>(versionData.text);
            StartCoroutine(LoadFix(data.FixUrl, data.Version));
        }
    }
   
    IEnumerator LoadFix(string fixUrl, string version) {

        //todo: check storage hotfix version

        WWW fixData = new WWW(fixUrl);

        yield return fixData;

        if (null != fixData.error) {
            Debug.LogError(fixData.error);
        } else {
            ApplyHotFix(fixData.text);
            SaveToStorage(fixData.text, version);
        }
    }

    void ApplyHotFix(string luastr) {
        luaevn.DoString(luastr);

        if(null != StartUp) {
            StartUp.SetActive(true);
        }
    }

    void SaveToStorage(string luastr, string version) {
        //todo
    }

    private void OnDestroy() {
       
    }
}

他会在游戏启动的时候去下载 http://www.dreamfairy.cn/xlua/test/version.txt 版本号数据
之后去补丁地址下载补丁文件 http://www.dreamfairy.cn/xlua/test/hotfix.lua

下载完毕后,缓存到本地, 然后调用游戏启动 StartUp

启动游戏后, 原本控制台输出 0 的结构, 热更新后 控制台输出 600

最后是lua部分的代码

xlua.private_accessible(CS.FuckYouSelf)

xlua.hotfix(CS.FuckYouSelf, 'Init',
function(self)
    self.A = 300
    self.B = 300
end
)

xlua.hotfix(CS.FuckYouSelf, 'Add',
function(self, a, b)
    return a + b
end
)

lua部分的代码,就3段 第一段 xlua.private_accessible(CS.FuckYouSelf)
让lua可以访问私有字段, 目的是为了改成员变量 A,B 他们是私有的

第二段是修改 类中的 Init函数, 来初始化A,B

第三段是修改 类中的 Add函数,让他正确执行加法

Unity3d 中的 HDR_BLOOM

虽然u3d标准资源包自带这货,但是我就喜欢重复造轮子,你奈我何

unity3d_hdr_bloom

简单来说 hdr_bloom 就3个Shader
第一个是shader, 筛选出像素亮度
第二个shader, 对像素进行模糊
第三个shader, 合并原始纹理 + 模糊亮度的纹理

第一个Shader
筛选亮度的算法

float brightness = col.r * 0.299 + col.g * 0.587 + col.b * 0.114;

之后我们给 Shader 一个 uniform 参数,作为亮度的调节参数即可

之后,为了让亮度周围出现光晕,我们将亮度纹理绘制在一张特别小的纹理上,然后再将这张小纹理进行拉伸,使其出现像素马赛克效果,这样处理后,迈赛克的亮度部分就会比原始纹理的明亮部分范围更大了,初步的光晕范围就出来了。
但是这部分光晕因为是马赛克,于是要将其进行模糊处理

绘制到缩小纹理再拉伸的效果是这样的

unity3d_hdr_bloom_2


请不要无脑复制转载本文, 由 dreamfairy 原创, 转载请注明出处 本文地址 http://www.dreamfairy.cn/blog/2016/05/28/unity3d-%e4%b8%ad%e7%9a%84-hdr_bloom/
那么实际操作的时候,我们将亮度提取的纹理先绘制到 1/16 大小的纹理上, 模糊后,再绘制到 1/8 纹理上, 然后 1/4, 1/2
最后将 1/2的模糊亮度纹理 和 原始纹理进行像素合并即可

这是模糊 1/2 后的纹理效果
unity3d_hdr_bloom_3

模糊的算法,原本采用 3×3 的二维高斯模糊算法,但是实际上和 2×2 的平滑模糊效果差不多, 于是就使用 2×2 的平滑模糊算法来做, 实际上使用 2个pass, 1个pass使用纵向3次 一维高斯算法, 1个pass 使用横向3次 一维高斯算法的效果最好, 不过我目前在做手机上的shader,差这么一点变现力还是可以接受的。

后面是3个完整Shader

取亮度

Shader "Aoi/OutputLuminosityShader"
{
	Properties
	{
		_MainTex ("Texture", 2D) = "white" {}
		_Brightness("BrightnessBias", float) = 0.1
	}
	SubShader
	{
		Tags { "RenderType"="Opaque" }
		LOD 100

		Pass
		{
			CGPROGRAM
			#pragma vertex vert
			#pragma fragment frag
			// make fog work
			#pragma multi_compile_fog
			
			#include "UnityCG.cginc"

			struct appdata
			{
				float4 vertex : POSITION;
				float2 uv : TEXCOORD0;
			};

			struct v2f
			{
				float2 uv : TEXCOORD0;
				UNITY_FOG_COORDS(1)
				float4 vertex : SV_POSITION;
			};

			sampler2D _MainTex;
			uniform float _Brightness;
			float4 _MainTex_ST;
			
			v2f vert (appdata v)
			{
				v2f o;
				o.vertex = mul(UNITY_MATRIX_MVP, v.vertex);
				o.uv = TRANSFORM_TEX(v.uv, _MainTex);
				UNITY_TRANSFER_FOG(o,o.vertex);
				return o;
			}
			
			fixed4 frag (v2f i) : SV_Target
			{
				// sample the texture
				fixed4 col = tex2D(_MainTex, i.uv);
				float brightness = col.r * 0.299 + col.g * 0.587 + col.b * 0.114;

				if (brightness < _Brightness) {
					col.rgb = 0;
				}

				// apply fog
				UNITY_APPLY_FOG(i.fogCoord, col);
				return col;
			}
			ENDCG
		}
	}
}

2×2模糊

Shader "Aoi/2x2SimpleBlur"
{
	Properties
	{
		_MainTex ("Texture", 2D) = "white" {}
	}
	SubShader
	{
		Tags { "RenderType"="Opaque" }
		LOD 100

		Pass
		{
			CGPROGRAM
			#pragma vertex vert
			#pragma fragment frag
			
			#include "UnityCG.cginc"

			struct appdata
			{
				float4 vertex : POSITION;
				float2 uv : TEXCOORD0;
			};

			struct v2f
			{
				float2 uv : TEXCOORD0;
				float4 leftUpUV : TEXCOORD1;
				float4 rightDownUV : TEXCOORD2;
				float4 vertex : SV_POSITION;
			};

			sampler2D _MainTex;
			float4 _MainTex_ST;
			float4 _MainTex_TexelSize;
			
			v2f vert (appdata v)
			{
				v2f o;
				o.vertex = mul(UNITY_MATRIX_MVP, v.vertex);

				float2 uv = TRANSFORM_TEX(v.uv, _MainTex);
				o.uv = uv;
				o.leftUpUV = float4(uv.x - _MainTex_TexelSize.x, uv.y, uv.x, uv.y + _MainTex_TexelSize.y);
				o.rightDownUV = float4(uv.x + _MainTex_TexelSize.x, uv.y, uv.x, uv.y - _MainTex_TexelSize.y);
				
				return o;
			}
			
			fixed4 frag (v2f i) : SV_Target
			{
				// sample the texture
				fixed4 col = tex2D(_MainTex, i.uv);
				
				col += tex2D(_MainTex, i.leftUpUV.xy);
				col += tex2D(_MainTex, i.leftUpUV.zw);
				col += tex2D(_MainTex, i.rightDownUV.xy);
				col += tex2D(_MainTex, i.rightDownUV.zw);

				col /= 5;
				
				return col;
			}
			ENDCG
		}
	}
}

合并纹理 的shader 就不上了
实际C# Code

using UnityEngine;
using System.Collections;

public class HDRBloomPostEffect : MonoBehaviour {
    public float BrightnessBias = 1.0f;

    private Material m_hdrBloomMat;
    private Material m_filterMat;
    private Material m_combineMat;

    // Use this for initialization
    void Start () {
        m_hdrBloomMat = new Material(Shader.Find("Aoi/OutputLuminosityShader"));
        m_filterMat = new Material(Shader.Find("Aoi/2x2SimpleBlur"));
        m_combineMat = new Material(Shader.Find("Aoi/CombineTex"));
    }

    float ComputeGaussianWeight(int posX, int posY, float sigma)
    {
        float v1 = 1.0f / (2.0f * Mathf.PI * sigma * sigma);
        float v2 = -(posX * posX + posY * posY) / (2 * sigma * sigma);
        v2 = Mathf.Exp(v2);

        return v1 * v2;
    }

    void OnRenderImage(RenderTexture src, RenderTexture dst) {
        RenderTexture rt16 = RenderTexture.GetTemporary(src.width / 16, src.height / 16);
        RenderTexture rt8 = RenderTexture.GetTemporary(src.width / 8, src.height / 8);
        RenderTexture rt4 = RenderTexture.GetTemporary(src.width / 4, src.height / 4);
        RenderTexture rt2 = RenderTexture.GetTemporary(src.width / 2, src.height / 2);

        m_hdrBloomMat.SetFloat("_Brightness", BrightnessBias);
        Graphics.Blit(src, rt16, m_hdrBloomMat);

        Graphics.Blit(rt16, rt8, m_filterMat);
        Graphics.Blit(rt8, dst, m_filterMat);
        Graphics.Blit(rt4, rt2, m_filterMat);

        m_combineMat.SetTexture("_AnotherTex", src);
        Graphics.Blit(rt2, dst, m_combineMat);

        RenderTexture.ReleaseTemporary(rt16);
        RenderTexture.ReleaseTemporary(rt8);
        RenderTexture.ReleaseTemporary(rt4);
        RenderTexture.ReleaseTemporary(rt2);
    }
}

榨干GPU 使用顶点颜色信息来创建千千万的高性能植被

gdc vertex color

之前做Terrain Brush Grass 的时候一直被它的性能折磨,稍微密集一些的植被,帧数直接变为个位数。 而GDC上使用顶点动画的想法瞬间给了我许多启发。

说干,就干。
在 Unity 中拖出一个 Cube 拉伸出 草的模样,然后给顶点上色。 像这样
红色表示可以被晃动的顶点
绿色表示晃动的幅度

两个颜色叠加在一起的时候,就变成屎黄了。。。
不过根部没有颜色呈现黑色可以看出过度

vertex color1

最后在Shader如下

v2f vert (appdata v)
{
v2f o;
float scale = cos(_Time.y * _Speed) * v.color.r * (v.color.g);float szControl = randValue > 0.5;
v.vertex.z += scale * szControl;
v.vertex.x += scale * (1.0 – szControl);

float4 worldPos = mul(_Object2World, v.vertex);

o.normal = normalize(mul(_Object2World, v.normal));
o.worldPos = worldPos;
o.pos = mul(UNITY_MATRIX_VP, worldPos);
o.uv = TRANSFORM_TEX(v.texcoord, _MainTex);

return o;
}

fixed4 frag (v2f i) : SV_Target
{
float3 lightDir = normalize(WorldSpaceLightDir(i.worldPos));
float3 viewDir = normalize(_WorldSpaceCameraPos – i.worldPos);
float3 halfDir = normalize(lightDir + viewDir);
float3 diffuse = tex2D(_MainTex, i.uv) * max(0, dot(i.normal, lightDir));
float3 specular = _LightColor0.rgb * pow(max(0, dot(i.normal, halfDir)), _Shiness);
float4 finalCol = float4(diffuse + specular + UNITY_LIGHTMODEL_AMBIENT, 1.0);

return finalCol;
}

最后我在场景中放了 2.0w 根草, 随机摆动 draw call 1, 25帧
使用Terrain 的 Grass Brush 2000个草,就已经在 2.5帧了
grass