[ASP.NET MVC 小牛之路]03 - Razor语法

在ASP.NET MVC开发中,视图层负责将服务器端数据渲染为用户可见的HTML界面。Razor作为微软官方推出的服务器端视图引擎,凭借其简洁易读的语法、与HTML的无缝集成能力,成为了ASP.NET MVC及Core开发的首选视图技术。本文将从基础到高级,全面解析Razor语法的核心特性、最佳实践及常见问题,帮助新手快速掌握Razor的使用技巧,构建高效可维护的视图层代码。

目录#

  1. 什么是Razor视图引擎?
  2. Razor核心语法基础 2.1 代码块与表达式 2.2 变量与数据类型 2.3 控制流语句(条件、循环) 2.4 注释语法
  3. Razor与HTML的无缝集成 3.1 混合HTML与代码逻辑 3.2 HTML转义与原义输出处理
  4. Razor高级特性 4.1 布局页面(Layout)与节(Section) 4.2 部分视图(Partial View) 4.3 视图组件(View Component) 4.4 Tag Helpers vs HTML Helpers
  5. Razor开发最佳实践
  6. 常见问题与解决方案
  7. 总结
  8. 参考资料

1. 什么是Razor视图引擎?#

Razor是一种服务器端视图引擎,专为ASP.NET MVC/Core设计,核心目标是简化服务器端代码与HTML的混合编写,提升代码可读性和开发效率。它具有以下关键特性:

  • 简洁语法:以@作为核心标识符号,最小化代码冗余,减少"噪音"。
  • 多语言支持:兼容C#和VB.NET,满足不同开发者的语言偏好。
  • 无缝集成:无需额外标签即可在HTML中嵌入服务器端逻辑,实现代码与界面的自然融合。
  • 安全默认:自动对用户输入进行HTML转义,预防XSS攻击。
  • 跨版本兼容:支持传统ASP.NET MVC和现代ASP.NET Core框架。

2. Razor核心语法基础#

2.1 代码块与表达式#

Razor的核心语法分为两类:代码块(执行逻辑不直接输出)和表达式(输出结果到HTML)。

类型语法示例说明
表达式@variable 或 @(expression)直接将变量或表达式的结果渲染到HTML中,如@user.Name、@(age > 18 ? "成年" : "未成年")
代码块@{ ... }包含多行C#逻辑,无直接输出,用于变量声明、逻辑处理,如@{ var now = DateTime.Now; }

示例:

@{
    // 代码块:声明变量
    string userName = "张三";
    int userAge = 25;
}
 
<!-- 表达式:输出变量 -->
<p>欢迎您,@userName!您今年@userAge岁,@(userAge >= 18 ? "已成年" : "未成年")。</p>

2.2 变量与数据类型#

Razor变量的声明与C#完全一致,支持所有C#数据类型(值类型、引用类型、泛型等)。推荐使用强类型变量,避免弱类型的dynamic以获得智能提示和编译时检查。

示例:

@{
    // 值类型
    int score = 92;
    decimal price = 199.9m;
    bool isActive = true;
    
    // 引用类型
    DateTime createTime = DateTime.Now;
    List<string> hobbies = new List<string> { "读书", "编程", "跑步" };
    
    // 自定义类型(需提前定义模型类)
    UserModel user = new UserModel { Id = 1, Name = "李四", AvatarUrl = "/avatars/2.jpg" };
}
 
<p>创建时间:@createTime.ToString("yyyy-MM-dd HH:mm:ss")</p>
<p>爱好:@string.Join("、", hobbies)</p>
<p>用户头像:<img src="@user.AvatarUrl" alt="@user.Name" /></p>

2.3 控制流语句(条件、循环)#

Razor支持所有C#控制流语句,可直接嵌入HTML结构中实现动态渲染。

条件语句(if-else/switch)#

@{ int score = 78; }
 
@if (score >= 90)
{
    <span class="text-success">优秀</span>
}
else if (score >= 70)
{
    <span class="text-warning">良好</span>
}
else
{
    <span class="text-danger">不及格</span>
}
 
<!-- Switch语句 -->
@{ string orderStatus = "Pending"; }
@switch (orderStatus)
{
    case "Completed":
        <span class="badge bg-success">已完成</span>
        break;
    case "Pending":
        <span class="badge bg-info">待处理</span>
        break;
    default:
        <span class="badge bg-secondary">未知状态</span>
        break;
}

循环语句(foreach/for/while)#

@{
    // 循环渲染列表
    var products = new List<ProductModel>
    {
        new ProductModel { Id = 1, Name = "笔记本电脑", Price = 5999 },
        new ProductModel { Id = 2, Name = "无线鼠标", Price = 99 },
        new ProductModel { Id = 3, Name = "机械键盘", Price = 299 }
    };
}
 
<!-- Foreach循环 -->
<table class="table">
    <thead>
        <tr><th>ID</th><th>名称</th><th>价格</th></tr>
    </thead>
    <tbody>
        @foreach (var product in products)
        {
            <tr>
                <td>@product.Id</td>
                <td>@product.Name</td>
                <td>¥@product.Price</td>
            </tr>
        }
    </tbody>
</table>
 
<!-- For循环 -->
<ul>
    @for (int i = 1; i <= 5; i++)
    {
        <li>第@(i)项内容</li>
    }
</ul>

2.4 注释语法#

Razor提供两种注释方式,分别适用于服务器端和客户端:

类型语法示例说明
Razor服务器端注释@* 注释内容 *@仅在服务器端可见,不会被渲染到最终HTML中,用于标记服务器端逻辑。
HTML客户端注释<!-- 注释内容 -->会被输出到HTML源码中,可被浏览器查看,用于前端调试或说明。

示例:

@* 服务器端注释:仅开发人员可见,不会出现在HTML中 *@
<!-- 客户端注释:用户可通过浏览器查看源码看到此内容 -->
<p>这是可见的内容</p>

3. Razor与HTML的无缝集成#

3.1 混合HTML与代码逻辑#

Razor允许在HTML标签的任意位置嵌入服务器端逻辑,无需额外的分隔符,实现逻辑与界面的自然融合。

示例:动态设置HTML属性

@{
    bool isHighlight = true;
    string buttonClass = isHighlight ? "btn btn-primary" : "btn btn-secondary";
}
 
<!-- 动态设置class属性 -->
<button class="@buttonClass" type="button">点击我</button>
 
<!-- 动态生成链接 -->
<a href="/user/@user.Id" title="查看@user.Name的详情">查看详情</a>

3.2 HTML转义与原义输出#

为了安全,Razor默认会对所有表达式输出进行HTML转义,将特殊字符(如<、>、&)转换为HTML实体,防止XSS攻击。但有时我们需要输出原始HTML(如富文本内容),此时可使用以下方法:

方法示例说明
Html.Raw()@Html.Raw(richContent)直接输出原始HTML,跳过转义。需确保内容安全,避免用户输入的未过滤内容。
IHtmlString类型new HtmlString(richContent)与Html.Raw()效果一致,适用于在控制器中预处理后传递给视图。

示例:

@{
    // 用户输入的富文本内容(假设已过滤)
    string richContent = "<strong>这是加粗的文本</strong><p>这是一段段落。</p>";
}
 
<!-- 默认转义输出:会显示原始HTML标签 -->
<p>转义输出:@richContent</p>
 
<!-- 原义输出:会渲染为加粗文本和段落 -->
<p>原义输出:@Html.Raw(richContent)</p>

4. Razor高级特性#

4.1 布局页面(Layout)与节(Section)#

布局页面用于定义网站的通用结构(如页头、导航、页脚),避免重复编写相同HTML代码。通过Section可实现视图与布局的交互,允许视图向布局的指定区域注入内容。

步骤1:创建布局页面(_Layout.cshtml)#

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>@ViewBag.Title - 我的网站</title>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
    <!-- 通用导航 -->
    <nav class="navbar">
        <a href="/">首页</a>
        <a href="/about">关于我们</a>
        <a href="/contact">联系我们</a>
    </nav>
 
    <!-- 视图的主内容区域 -->
    <main class="container">
        @RenderBody()
    </main>
 
    <!-- 可选节:视图可选择是否实现 -->
    @RenderSection("Scripts", required: false)
 
    <!-- 通用页脚 -->
    <footer>
        <p>© 2024 我的网站 版权所有</p>
    </footer>
</body>
</html>

步骤2:在视图中使用布局#

<!-- 指定布局(若在_ViewStart.cshtml中已设置默认布局,可省略此步) -->
@{
    Layout = "_Layout";
    ViewBag.Title = "首页";
}
 
<!-- 视图主内容 -->
<h1>欢迎来到首页</h1>
<p>这是首页的专属内容。</p>
 
<!-- 注入脚本到布局的Scripts节 -->
@section Scripts {
    <script src="/js/home.js"></script>
}

步骤3:全局默认布局(_ViewStart.cshtml)#

创建Views/_ViewStart.cshtml文件,可设置所有视图的默认布局:

@{
    Layout = "_Layout";
}

4.2 部分视图(Partial View)#

部分视图是可复用的UI片段,用于提取重复的HTML代码(如用户头像、评论列表)。它不包含布局,仅专注于单一功能的UI展示。

步骤1:创建部分视图(_UserAvatar.cshtml)#

@model UserModel
<div class="avatar-container">
    <img src="@Model.AvatarUrl" alt="@Model.UserName" class="avatar" />
    <span class="user-name">@Model.UserName</span>
</div>

步骤2:在视图中调用部分视图#

@{
    UserModel currentUser = new UserModel { Id = 1, UserName = "王五", AvatarUrl = "/avatars/3.jpg" };
}
 
<!-- 方式1:HTML Helper -->
@Html.Partial("_UserAvatar", currentUser)
 
<!-- 方式2:Tag Helper(ASP.NET Core推荐) -->
<partial name="_UserAvatar" model="currentUser" />

4.3 视图组件(View Component)#

视图组件是比部分视图更强大的复用技术,适用于包含业务逻辑的复杂UI组件(如最新文章列表、购物车摘要)。它支持依赖注入、异步操作,且与控制器解耦。

步骤1:创建视图组件类#

public class RecentPostsViewComponent : ViewComponent
{
    private readonly IPostService _postService;
 
    // 依赖注入服务
    public RecentPostsViewComponent(IPostService postService)
    {
        _postService = postService;
    }
 
    // 异步调用方法
    public async Task<IViewComponentResult> InvokeAsync(int count = 5)
    {
        // 从服务获取数据
        var recentPosts = await _postService.GetRecentPostsAsync(count);
        return View(recentPosts);
    }
}

步骤2:创建视图组件的视图#

在Views/Shared/Components/RecentPosts/Default.cshtml中编写UI:

@model IEnumerable<PostModel>
<div class="recent-posts">
    <h4>最新文章</h4>
    <ul>
        @foreach (var post in Model)
        {
            <li><a href="/posts/@post.Id">@post.Title</a></li>
        }
    </ul>
</div>

步骤3:在视图中调用视图组件#

<!-- 方式1:HTML Helper -->
@await Component.InvokeAsync("RecentPosts", new { count = 3 })
 
<!-- 方式2:Tag Helper(ASP.NET Core推荐) -->
<vc:recent-posts count="3"></vc:recent-posts>

4.4 Tag Helpers vs HTML Helpers#

Tag Helpers是ASP.NET Core引入的新特性,与HTML Helpers相比,它更贴近标准HTML语法,可读性更强,便于前端开发者理解和维护。

类型示例(生成首页链接)说明
HTML Helpers@Html.ActionLink("首页", "Index", "Home")采用方法调用语法,代码与HTML分离,适合后端开发者。
Tag Helpers<a asp-action="Index" asp-controller="Home">首页</a>采用HTML标签属性语法,保持HTML结构的完整性,适合前后端协作开发。

Tag Helpers的优势:

  • 与标准HTML一致,学习成本低。
  • 支持智能提示和语法高亮。
  • 可自定义扩展,实现复杂的UI组件。

5. Razor开发最佳实践#

  1. 分离关注点:视图仅负责展示逻辑,避免在Razor中编写复杂业务逻辑(应将业务逻辑放在控制器、服务层)。
  2. 使用强类型视图:优先通过@model声明强类型模型,避免使用ViewBag/ViewData的弱类型(无智能提示,易出错)。
  3. 复用优先:将通用UI片段抽离为部分视图或视图组件,将通用页面结构抽离为布局页面,减少重复代码。
  4. 安全输出:默认依赖Razor的自动转义,仅在内容安全时使用Html.Raw(),避免XSS攻击。
  5. 避免硬编码:使用Tag Helpers或Url.Action()生成URL,避免硬编码路径,确保路由变更时自动更新。
  6. 异步优先:对于涉及IO操作的组件(如视图组件),使用异步方法(async/await),提升服务器并发能力。
  7. 代码规范:保持代码缩进一致,合理使用注释,避免过长的代码块(复杂逻辑应移至服务层)。

6. 常见问题与解决方案#

问题1:Razor表达式未正确输出内容#

  • 原因:表达式未使用@标识,或复杂表达式未用@()包裹。
  • 解决方案:确保变量前添加@,复杂逻辑用@()包裹,如@(user.Age >= 18 ? "成年" : "未成年")。

问题2:Layout中的Section未找到报错#

  • 原因:视图未实现Layout中要求的必填Section。
  • 解决方案:在视图中添加对应的@section代码块,或在Layout的RenderSection中设置required: false。

问题3:Tag Helpers不生效#

  • 原因:未在_ViewImports.cshtml中注册Tag Helpers。
  • 解决方案:在Views/_ViewImports.cshtml中添加:
    @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

问题4:强类型视图模型不匹配报错#

  • 原因:控制器传递的模型类型与视图@model声明的类型不一致。
  • 解决方案:检查控制器的return View(model)中的model类型,确保与视图的@model类型完全匹配。

7. 总结#

Razor作为ASP.NET MVC/Core的核心视图技术,通过简洁的语法、强大的集成能力和丰富的高级特性,为开发者提供了高效的视图开发体验。从基础的表达式、控制流到高级的布局、视图组件,掌握Razor的核心特性和最佳实践,是构建高质量ASP.NET MVC应用的必备技能。希望本文能帮助新手快速入门Razor,在"小牛之路"上稳步前进。


8. 参考资料#

  1. ASP.NET Core Razor 语法官方文档
  2. Pro ASP.NET Core MVC 6(Adam Freeman 著)
  3. ASP.NET MVC 视图最佳实践
  4. Razor 视图组件官方教程