【HTML5】使用 HTML5 Boilerplate 开始您的 web 开发

时间 2019-11-07

标签 HTML5 使用 html5 html boilerplate 开始您的 web 开发栏目 HTML5 繁體版

原文原文链接

web 开发团队的一个常见实践是建立一组标准文件，团队成员基于它们开始 web 开发流程，包括一个公共文件结构、基本命名惯例和标准库。这样作可以更容易启动并运行一个项目。它还能将开发人员引向内部编码标准并实施标准文件组织。 HTML5 Boilerplate 就是这种处于 web 开发最前沿的完美理念的实现。css

结合了使用 HTML5 须要的几个加强和许多其余最佳实践，只需最少的前期投资，HTML5 Boilerplate 就能为您的项目提供一个坚如磐石的基础。本文简述了使用 HTML5 Boilerplate 来开始一个项目的方法，展现了一些可以对其进行调优，使其适应一个已有框架和编码风格的方法。html

HTML5 组件前端

HTML5 Boilerplate 的核心是用于帮助开发 HTML5 站点和应用程序的组件，包括：html5

Modernizr，一个小型实用程序库，支持在 Windows® Internet Explorer® 中设置新的 HTML5 元素样式，并协助在全部浏览器中进行 HTML5/CSS3 特性检测。若是您正在使用 HTML5 进行开发且须要支持 Internet Explorer 版本 9 以前的浏览器版本，那么这个库（或者我稍后将解释的一个替代选项）将是您的项目必不可少的一个组件。nginx
构建于 HTML5 Doctor Reset 之上的一个 CSS 起始文件，包含几个智能默认值和加强。git
内置 HTML5 语法，以及一些新的语义元素，用于构成您文档的骨架。github

除了这些核心的 HTML5 相关特性，该项目还实现了几个优秀的最佳实践。下面列出了部分最佳实践：web

在整个项目过程当中很是关注前端性能，采用适当的结构（CSS 位于顶部，JavaScript 代码位于底部），一个 Google Analytics 异步实现，以及项目的 Apache ANT 构建脚本中提供的几个基于性能的加强。shell
几个跨浏览器助手，包括 HTML 元素上的特定于 Internet Explorer 版本的类和一个针对 Internet Explorer 版本 6 的自动 PNG 补丁。windows
样例 .htaccess 和 web.config 文件，帮助您设置您的服务器来利用 HTML5 特性和 web 字体并经过一个智能缓存策略加速您的站点。
远远超出典型重置范围的 CSS 加强。这个样式表使用精心挑选和偶尔聪明的默认值重构元素。它还添加了几个方便的助手类。常见的 .clearfix 类是您须要熟悉的类，.hidden 和.visuallyhidden 等类也包含在内且很是有用。骨架打印样式（Skeleton print styles）、分页媒体样式和用于快速响应 web 设计的媒体查询也被包含进来。

尽管看起来已经很多了，但上面的列表只是这个项目附带的最佳实践的一个样本。即便对于持续关注这些事情的人来讲，这也是一个使人印象深入的集合。事实上，这个集合是如此使人印象深入，以致于该项目认可这样一个事实：这个集合是 “删除键友好的”。这句话的意思是：它是一个健壮的集合，并非每一个人都须要在每一个项目中默认包含每一个特性。

全部这一切都指向一个使用 HTML5 Boilerplate 的核心教训：因为 HTML5 Boilerplate 意味着被用做一个基础，所以在项目启动时启用这些文件不是可选项，并且是 必须执行的操做。认识到这一点以后，咱们如今能够开始逐步演示一个 HTML5 Boilerplate 项目并使用那个删除键来定制它了。

回页首

使用 Boilerplate

当您阅读下面的小节时，请记住，这个逐步演示的目的并非规定您应该如何设置您的项目，而是演示您如何可以和应该如何解决这个问题，以便这个基础平台适应您的特定项目和开发风格。

获取代码

要得到代码，最简单的方法就是从项目网站下载（见参考资料）。鉴于本文的目的，我假定您已经下载代码，得到了 stripped 版本。

或者，若是您喜欢使用 git，则能够克隆这个项目，而后使用下面任一方法获取一个干净的项目副原本使用：

若是您可以访问一个 UNIX® shell，那么能够导航到项目的构建目录并运行其中的 createproject.sh 文件，这将在 HTML5 Boilerplate 根文件夹中生成一个干净的目录。
若是您处于一台 Windows 机器上，或者在放置输出文件方面想要更多灵活性，于是不能运行 shell 脚本，那么您能够检查 stripped 的分支，而后下载一个存档文件。一般，您使用 Smart Git 或 TortoiseGit 这样的工具来执行这个操做，但也能够从命令行执行，以下所示：
git checkout -b stripped origin/stripped git archive stripped --format=zip --output=/path/to/your/files.zip

不管您采用哪一种方法，都须要移动到您新建立的副本并进行定制。

回页首

定制

一般，我进行的首次编辑取决于我计划使用高级 HTML五、CSS3 或其余新兴技术的程度。若是您正在建立一个内容站点或博客，且只想使用新的语义标记对您的站点进行 “将来证实（future-proof）”，那么可使用 html5shiv 这个小代码段替换外部 Modernizr 脚本。html5shiv 代码的用途是使 CSS 在 Internet Explorer 的较早版本中用于新的语义元素。Modernizr 比较快，但若是您不打算利用测试 Modernizr 发布，那么能够经过选择简化选项来为您的用户节约几毫秒时间。

我常常自动删除的一个部分是位于底部的配置部分。若是不用它，最好当即删除。根据您的当前项目的需求，您也能够删除用于 Internet Explorer 6 的 PNGFix 解决方案。

在 HTML 文档外部，您能够当即删除项目根目录中的一些文件和文件夹，缘由是您不须要它们（test 文件夹、web.config、crossdomain.xml 和 nginx.conf），或者拥有本身的版本（robots.txt 和 .htaccess）。

一个额外的注意事项

若是您在一台运行 Windows 的机器上使用文件 protocol 开发模板并在 Internet Explorer 中测试它们，那么您确定熟悉那些无穷无尽的安全对话框，只要您试图运行任何内容 — 即便以远程交互式方式运行 — 那些对话框就会弹出来。要消除这个现象，只需将 “Mark of the Web” 直接插入 doctype 声明以后。这个简单的代码段将把 Internet Explorer 放入 Internet 区，并抑制使人讨厌的安全对话框。

<!doctype html> <!-- saved from url=(0014)about:internet -->

注意，这段代码也被项目的构建脚本剥离出去，所以它不会进入生产环境。

文件夹结构

这不是一个典型定制，但它真的展现了这样一个事实：HTML5 Boilerplate 是一个基础 — 仅此而已。若是您不喜欢某个内容，尽管修改它。您才是那个推进项目前进的人。

每当我开始一个项目时，我都首先调整文件夹结构。现有结构没有任何错误：我只是喜欢将全部静态资产（脚本、flash 元素、图像、样式表）放置到一个名为 _assets 的顶级目录中。这样作将保持一个更整洁的根目录，将那些常常被引用的元素推到文件窗口中的目录树的顶端。除此以外，我还在 CSS 文件夹中添加两个子目录，分别用于 Web 字体和 CSS 图像。因为之前处理过许多将图像用做内容的站点，我喜欢将内容图像和界面图像分离开来，这就须要新建两个文件夹。

我还要简化 js 文件夹的层级结构，方法是删除 libs、mylibs 和 profiling 目录，将它们的内容移动到一个扁平的 js 目录中。完成后的结果如图 1 所示。

图 1. 新文件夹结构

此时，我只是确保 HTML 文档中的路径匹配新现实，我本身进行了一些调整。我还对构建脚本进行了一些调整，这将在下一节中介绍，但总的来讲，我准备好开始个人新项目了。

回页首

构建脚本

当您准备好打包您的站点时 — 要么做为一个静态站点交付，要么做为一个未来用于与一个 CMS 或其余平台集成的构建工具，是时候访问 /build 目录了。就目前而言，HTML5 Boilerplate 拥有一个 ANT 构建脚本，该脚本包含几个用于打包内容的有用任务。

注意：若是您想将其余构建系统集成到您的项目中而且您是一个 Rake、Apache Maven 或其余构建系统大师，那么您能够直接使用 github，分割项目，进行构建。

构建脚本的功能

使用 ANT — 一个基于 Java™ 的构建工具，这个构建脚本执行如下任务：

使用 YUI 压缩程序合并和缩小 JavaScript
合并和缩小 CSS
使用 jpegtran 和 optipng 优化 JPG 和 PNG 文件
移除仅用于开发的代码
使用 htmlcompressor 配置 HTML 缩小
修改文件名进行智能缓存（特别是缓存已更新的文件）

有 4 个任务您应该注意：

build。 执行细小的 HTML 优化，缩小内联脚本和样式，链接和缩小外部 JavaScript 代码和 CSS，处理图像
buildkit。 保留 HTML 空白以在从此的生产流程中保持可读性，缩小内联脚本和样式，链接和缩小外部 JavaScript 代码和 CSS，处理图像
minify。 执行完整的 HTML 缩小，缩小内联脚本和样式，链接和缩小外部 JavaScript 代码和 CSS，处理图像
text。 执行完整的 HTML 缩小，JavaScript 代码缩小，链接和 CSS 缩小，不执行图像优化

若是您正在运行默认 boilerplate，那么只要您安装了 Java 且您的路径中有 ANT，上述任务就应该可以完成。

若是您和我同样，也对您的文件架结构进行了一些调整，那么您必须对构建脚本进行一些定制。您将在一个名为 build.properties 的文件中进行大部分更改，您可能必须调整构建脚本中的一到两行。

build.properties 中的更改（如清单 1 所示）都是基于目录的。变量被更新为将构建脚本指向 JavaScript 代码、CSS 和图像的新位置。

清单 1. 示例 build.properties 文件

#build properties is where you override default configuration elements. #in my case I just need to set some new folder references. # Custom Build options --------------------------------- # Project structure ----------------------------- # Directory names dir.assets   = _assets dir.js  = ${dir.assets}/js # Main JS script folder (Will be concatenated and minified) dir.js.main  = ${dir.js} dir.css  = ${dir.assets}/css dir.images  = ${dir.build}/images dir.cssimages  =${dir.css}/images

对于个人环境，我须要修改 build.xml 中的一行来引用个人第二个图像目录。清单 2 展现了这个简单的更改。您将在这里看到操做系统级分支，所以下面的示例使用一个 Windows 环境。还有针对 Linux® 和 Mac OS X 的分支，那里也须要进行相似的更改。

清单 2. 编辑 build.xml

<target name="imagesjpg" depends="copy"> <echo message="Clean up those jpgs..."/> [snip...] <apply executable="tools/jpegtran.exe" osfamily="windows"> <fileset dir="./${dir.publish}/${dir.images}/" includes="*.jpg"/> <!-- Adding in my css/images directory --> <fileset dir="./${dir.publish}/${dir.cssimages}/" includes="*.jpg"/> [snip...] </target>

进行这些更改以后，您就得到了一个根据您的喜爱进行调整的、功能齐全的项目，您已准备好构建优化代码了。

回页首

结束语

如您所见，进入 HTML5 Boilerplate 项目的门槛很是低，有充足的空间用于试验。您能够将这个项目做为您的试验项目，探索它带来的好处，若是其中有任何缺失或您不须要的东西，尽管进行相应修改。