.NET分离exe和dll在不同的目录让你的程序更整洁

程序员文章站 2022-06-02 10:38:00

...

1、引言

在一个项目开发中一般都是把引用的dll放在根目录下，随着项目的日益增大，根目录下的dll文件就会越来越多，合理规划这些dll的存放地址，可以使整个项目更加的规范与美观。这篇文章就为大家介绍关于C#如何在指定文件夹寻找文件dll的相关内容，文中通过基于RDIFramework框架WinForm版为基础进行介绍，Web的相关dll规划类似，希望对大家具有一定的参考学习价值。

我们框架原执行目录下的dll存放如下，可以看到整个目录下的文件非常多。
.NET分离exe和dll在不同的目录让你的程序更整洁

博客分类： RDIFramework.NET数据库开发应用.NET技术项目总结计算机常用知识 RDIFramework.NET.NET快速开发框架敏捷开发框架WinForm开发框架Web开发框架

下面我们通过最常用的方式对dll文件进行规划处理，使整个运行目录更加的干净，规范，最终效果如下图所示。
.NET分离exe和dll在不同的目录让你的程序更整洁

博客分类： RDIFramework.NET数据库开发应用.NET技术项目总结计算机常用知识 RDIFramework.NET.NET快速开发框架敏捷开发框架WinForm开发框架Web开发框架

可以看到，上图的整个运行目录结构非常的清爽与整洁了。如何实现的呢？下面我们就具体讲解。

2、实现方法

CLR解析一个程序集会在一个根目录内进行搜索，整个探索过程又称Probing，这个根目录很显然就是当前包含当前程序集的目录。
AppDomainSetup这个类存储着探索目录的信息，其成员包括：ApplicationBase、PrivateBinPath。
程序搜索dll的顺序如下(区分强名称签名的和没有强名称签名的程序集)：
没有做强名称签名的程序集：

程序的根目录

根目录下面，与被引用程序集同名的子目录

根目录下面被明确定义为私有目录的子目录

在目录中查找的时候，如果dll查找不到，则会尝试查找同名的exe

如果程序集带有区域性，而不是语言中立的，则还会尝试查找以语言区域命名的子目录

具有强名称签名的程序集：

全局程序集缓存

如果有定义codebase，则以codebase定义为准，如果codebase指定的路径找不到，则直接报告错误

程序的根目录

根目录下面，与被引用程序集同名的子目录

根目录下面被明确定义为私有目录的子目录

在目录中查找的时候，如果dll查找不到，则会尝试查找同名的exe

如果程序集带有区域性，而不是语言中立的，则还会尝试查找以语言区域命名的子目录。如下图所示：

我们看到，上面的顺序无论是否有强名称签名，都会用到私有目录，要实现程序识别不同目录下的dll文件，一般有三种方式。

1、配置App.config文件的privatePath——【推荐】。

2、订阅程序集解析事件AssemblyResolve在代码中解析。

3、在加载使用到dll的代码之前重置当前环境的目录。

这是最简单最常用的方法，也是我们采用的方式。这儿要说明的是此方法有一定的局限性，就是没法对dll做控制，另外无法解决第三方DllImprt中引入的程序集不在根目录下的问题。配置如下，多个目录用;分隔。

<configuration>
<runtime>
      <!--xmlns是必需的特性。指定程序集绑定所需的 XML 命名空间。 使用字符串“urn: 架构-microsoft-com:asm.v1”作为值。-->
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
        <publisherPolicy apply="yes"/>  <!--指定运行时是否使用发布者策略-->
        <!--指定加载程序集时公共语言运行时搜索的子目录, 其中privatePath是相对于*.exe.config文件的相对路径，多个文件夹以分号分隔。-->
        <probing privatePath="devLibs;3rdLibs;frameworkLibs"/>
    </assemblyBinding>
  </runtime>
</configuration>

其中privatePath是相对于*.exe.config文件的相对路径，多个文件夹以分号分隔。当编译后会在生成目录下生成一个后缀为.exe.config的文件，就是相对这个文件的。
添加程序集DLL引用之后，将DLL的属性“复制本地”设置为False。程序编译过程中，会自动检索Common和Security文件夹下的DLL及其依赖项。

我们框架就是使用这种方式来实现，最终的运行目录结构效果如下。
.NET分离exe和dll在不同的目录让你的程序更整洁

博客分类： RDIFramework.NET数据库开发应用.NET技术项目总结计算机常用知识 RDIFramework.NET.NET快速开发框架敏捷开发框架WinForm开发框架Web开发框架

应用程序集域中支持在程序集解析时的处理：

AppDomain.CurrentDomain.AssemblyResolve += CurrentDomain_AssemblyResolve;

通过这个事件，我们可以在程序集解析时，根据不同的程序集做不用的处理，比如加载x86的程序集还是64位的程序集，当然也就可以指定程序集目录了。这也正是Assembly.Load和Assembly.LoadFrom等方法的用武之地。

Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEventArgs args)
{
    AssemblyName assemblyName = new AssemblyName(args.Name);
    return Assembly.LoadFrom(Path.Combine(baseDirectory, "3rdLibs"));
}

这个方法是通过Environment.CurrentDirectory=customPath，这样在调用dll方法时，因为目录已经切换到了我们指定的目录下，就可以实现相应的dll正确的加载。这是一个取巧的方法不是很实用，需要来回切换程序集目录，但是在某些情况下非常好用。

针对dllImport也分为几种情况。

自己写dllImport

引用的C#的插件又使用了dllImport

如果是自己写的就非常好控制了，可以直接指定相对的目录DllImport(3rdLibs\NLog.dll)。不过这种方法不一定可靠，在某些系统加载不了，如果使用了dllImport还是，推荐下面的介绍的方法（引用的C#的插件又使用了dllImport）。

2.3.2、引用的C#的插件又使用了`dllImport`

因为无法更改路径，那么只能够使用上述特殊的方法，更改当前程序的路径
当然，还有更省事一点的做法，就是在系统环境中，增加一条记录，指向要加载的dll的所在目录。因为C++的代码中，Windows目录和Windows\System32目录以及环境变量设定的目录都是搜索路径之一。
这里提供怎么从C#中修改系统环境变量的代码：

static void AddEnvironmentPaths(IEnumerable<string> paths)
{
    var path = new[] { Environment.GetEnvironmentVariable("PATH") ?? string.Empty };
    string newPath = string.Join(Path.PathSeparator.ToString(), path.Concat(paths));
    Environment.SetEnvironmentVariable("PATH", newPath);
}