.NET 4.8迁移.NET 6时URL重写对已有端点不生效问题排查

问题背景 #

我们正将.NET 4.8 ASP.NET WebAPI迁移至.NET 6，采用按控制器迁移端点的方案以降低对用户的影响：

• 旧API部署在api.abc.com，包含端点如https://api.abc.com/api/v1/test/data、https://api.abc.com/api/v1/test2/data2
• 新.NET 6 API部署在apiv2.abc.com，包含对应旧端点及新增端点https://apiv2.abc.com/api/v1/test/data3

在旧框架应用中配置了如下URL重写规则，意图将test控制器的所有端点转发至新API：

<rule name="Rewrite" stopProcessing="true">
  <match url="api/v1/(test)/(.*)" ignoreCase="true" />
  <action type="Rewrite" url="https://apiv2.abc.com/{R:0}" appendQueryString="true"/>
</rule>

实际出现异常：

• 访问旧API已存在的test控制器端点（如https://api.abc.com/api/v1/test/data）时，仍由旧.NET框架应用处理，未转发至新API
• 访问旧API不存在但匹配重写规则的端点（如https://api.abc.com/api/v1/test/data3）时，可正常转发至新API

问题原因分析 #

这是IIS URL重写模块的执行顺序导致的：

1. IIS会先检查当前请求的路径是否对应本地存在的资源或已注册的ASP.NET路由
2. 当请求的端点在旧API中已经存在（即ASP.NET路由能匹配到对应的控制器/动作），IIS会直接将请求交给旧ASP.NET应用处理，跳过URL重写规则
3. 只有当请求的端点在本地找不到匹配的路由时，IIS才会触发URL重写规则，将请求转发到新API

解决方案 #

要让重写规则优先于本地路由匹配执行，有两种修改方式：

方式1：添加条件强制跳过本地资源检查 #

<rule name="Rewrite" stopProcessing="true">
  <match url="api/v1/(test)/(.*)" ignoreCase="true" />
  <conditions>
    <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
    <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
    <add input="{URL}" pattern="api/v1/test/.*" ignoreCase="true" />
  </conditions>
  <action type="Rewrite" url="https://apiv2.abc.com/{R:0}" appendQueryString="true"/>
</rule>

方式2：直接添加checkIfFileExists="false"属性（IIS 7.5+支持） #

这是更简洁的写法，直接告诉IIS无需检查本地资源是否存在，强制执行重写：

<rule name="Rewrite" stopProcessing="true">
  <match url="api/v1/(test)/(.*)" ignoreCase="true" />
  <action type="Rewrite" url="https://apiv2.abc.com/{R:0}" appendQueryString="true" checkIfFileExists="false"/>
</rule>

内容的提问来源于stack exchange，提问作者Ipsit Gaur