静态页面实现 include 引入公用代码的示例


Posted in Javascript onSeptember 25, 2017

一直以来,我司的前端都是用 php 的 include 函数来实现引入 header 、footer 这些公用代码的,就像下面这样:

<!-- index.php -->
 
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>Document</title>
</head>
<body>
  <?php include('header.php'); ?>
  <div>页面主体部分</div>
  <?php include('footer.php'); ?>
</body>
</html>
<!-- header.php -->
<header>这是头部</header>
<!-- footer.php -->
<footer>这是底部</footer>

直到最近某个项目需要做一个 webapp,是通过 HBuilder 将静态页面打包成 APP,这就让我碰到难题了。

如果是小项目,那就直接手动多复制粘贴几遍,但如果页面较多,复制粘贴的方案明显不靠谱,维护成本也高。

在查了很多资料后,最终确定用 gulp 来解决,具体操作如下:

1、安装 gulp 和 gulp-file-include

首先新建个文件夹,在终端里定位到文件夹的位置,然后进行 npm 初始化

npm init

然后安装 gulp

npm install gulp --save-dev

接着安装 gulp-file-include

npm install gulp-file-include --save-dev

2、新建并配置 gulpfile.js

接着我们手动新建一个 js 文件取名为 gulpfile,并在里面写入如下代码:

var gulp = require('gulp');
var fileinclude = require('gulp-file-include');
 
gulp.task('fileinclude', function () {
  // 适配page中所有文件夹下的所有html,排除page下的include文件夹中html
  gulp.src(['page/**/*.html', '!page/include/**.html'])
    .pipe(fileinclude({
      prefix: '@@',
      basepath: '@file'
    }))
    .pipe(gulp.dest('dist'));
});

3、创建项目目录结构,并添加测试代码

项目的整体目录结构应该是这样

app

 page

include


 header.html


 footer.html


index.html

 gulpfile.js

 package.json

然后我们添加测试代码,header.html 和 footer.html 没太多好说的,主要是 index.html 要特别注意引入的方式,代码如下:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>Document</title>
</head>
<body>
  @@include('include/header.html')
  <div>页面主体部分</div>
  @@include('include/footer.html')
</body>
</html>

4、运行

在终端里敲入以下代码,看执行效果

gulp fileinclude

会发现,多了个 dist 文件夹,里面有一个 index.html 文件,gulp-file-include 已经帮我们把最终编译好的 index.html 文件生成好了。

可能你已经能举一反三了,在 gulpfile.js 里,我们可以手动设置最终生成文件的位置,就是这句话

gulp.dest('dist')

5、自动编译

静态页面引入公用代码的问题已经解决了,但每次编写源 html 后,都要去终端里手动执行下编译操作还是很麻烦,那能不能让文件自动编译呢?答案一定是可以的。

gulp 有个 watch 方法,就是监听文件是否有变动的,我们只需稍微修改下 gulpfile.js 文件,增加一段监听代码,如下:

var gulp = require('gulp');
var fileinclude = require('gulp-file-include');
 
gulp.task('fileinclude', function () {
  // 适配page中所有文件夹下的所有html,排除page下的include文件夹中html
  gulp.src(['page/**/*.html', '!page/include/**.html'])
    .pipe(fileinclude({
      prefix: '@@',
      basepath: '@file'
    }))
    .pipe(gulp.dest('dist'));
});
 
gulp.task('watch', function () {
  gulp.watch('page/**/*.html', ['fileinclude']);
});

写好之后,我们只需在终端里执行

gulp watch

我们每次保存源 html 后,gulp 就会自动帮我们编译一遍。

至此,静态页面如何实现 include 引入公用代码的问题,顺利解决,最后附上相关资料。

以上这篇静态页面实现 include 引入公用代码的示例就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
js调试工具Console命令详解
Oct 21 Javascript
javascript实现日期按月份加减
May 15 Javascript
javascript中使用new与不使用实例化对象的区别
Jun 22 Javascript
jquery实现滑动特效代码
Aug 10 Javascript
Vue.js 2.0 和 React、Augular等其他前端框架大比拼
Oct 08 Javascript
js实现登录框鼠标拖拽效果
Mar 09 Javascript
BootStrap Select清除选中的状态恢复默认状态
Jun 20 Javascript
Vue脚手架的简单使用实例
Jul 10 Javascript
8 个有用的JS技巧(推荐)
Jul 03 Javascript
js函数和this用法实例分析
Mar 13 Javascript
Jquery+javascript实现支付网页数字键盘
Dec 21 jQuery
JS数组索引检测中的数据类型问题详解
Jan 11 Javascript
React学习之事件绑定的几种方法对比
Sep 24 #Javascript
一文让你彻底搞清楚javascript中的require、import与export
Sep 24 #Javascript
通过源码分析Vue的双向数据绑定详解
Sep 24 #Javascript
JS实现手写parseInt的方法示例
Sep 24 #Javascript
Js利用console计算代码运行时间的方法示例
Sep 24 #Javascript
详解Web使用webpack构建前端项目
Sep 23 #Javascript
vue webuploader 文件上传组件开发
Sep 23 #Javascript
You might like
全国FM电台频率大全 - 22 重庆市
2020/03/11 无线电
ThinkPHP关联模型操作实例分析
2012/09/23 PHP
php的hash算法介绍
2014/02/13 PHP
php实现基于微信公众平台开发SDK(demo)扩展的方法
2014/12/22 PHP
Yii2框架引用bootstrap中日期插件yii2-date-picker的方法
2016/01/09 PHP
CI框架的安全性分析
2016/05/18 PHP
PHP简单创建压缩图的方法
2016/08/24 PHP
php的RSA加密解密算法原理与用法分析
2020/01/23 PHP
基于jQuery的让非HTML5浏览器支持placeholder属性的代码
2011/05/24 Javascript
jQuery 选择表格(table)里的行和列及改变简单样式
2012/12/15 Javascript
jquery给图片添加鼠标经过时的边框效果
2013/11/12 Javascript
JS按回车键实现登录的方法
2014/08/25 Javascript
JavaScript实现简单图片翻转的方法
2015/04/17 Javascript
JavaScript变量的作用域全解析
2015/08/14 Javascript
jQuery鼠标事件汇总
2015/08/30 Javascript
jQuery插件之jQuery.Form.js用法实例分析(附demo示例源码)
2016/01/04 Javascript
js 自带的 map() 方法全面了解
2016/08/16 Javascript
在html中引入外部js文件,并调用带参函数的方法
2016/10/31 Javascript
浅析Node.js:DNS模块的使用
2016/11/23 Javascript
Bootstrap常用组件学习(整理)
2017/03/24 Javascript
学习Vue组件实例
2018/04/28 Javascript
在vue项目中集成graphql(vue-ApolloClient)
2018/09/08 Javascript
手动下载Chrome并解决puppeteer无法使用问题
2018/11/12 Javascript
微信小程序 数据缓存实现方法详解
2019/08/26 Javascript
Python3控制路由器——使用requests重启极路由.py
2016/05/11 Python
利用Python如何实时检测自身内存占用
2020/05/09 Python
CSS3实现红包抖动效果
2020/12/23 HTML / CSS
去加拿大的旅行和假期:Canadian Affair
2016/10/25 全球购物
英国户外装备和冒险服装零售商:alloutdoor
2018/01/30 全球购物
介绍一下ICMP(Internet Control Message Protocol)Internet控制信息协议
2016/11/26 面试题
质检部职责
2013/12/28 职场文书
协议书范本
2014/04/23 职场文书
会计学自荐信
2014/06/03 职场文书
社团活动总结怎么写
2014/06/30 职场文书
Vue项目打包、合并及压缩优化网页响应速度
2021/07/07 Vue.js
《火纹风花雪月无双》预告“神秘雇佣兵” 紫发剑客
2022/04/13 其他游戏