HTML5的自定义属性data-* 的用法解析

左手的ㄟ右手 2022-08-21 12:53 154阅读 0赞

人们总喜欢往HTML标签上添加自定义属性来存储和操作数据。但这样做的问题是，你不知道将来会不会有其它脚本把你的自定义属性给重置掉，此外，你这样做也会导致html语法上不符合Html规范，以及一些其它副作用。这就是为什么在HTML5规范里增加了一个自定义data属性，你可以拿它做很多有用的事情。

你可以去读一下HTML5的详细规范，但这个自定义data属性的用法非常的简单，就是你可以往HTML标签上添加任意以 `"data-"`开头的属性，这些属性页面上是不显示的，它不会影响到你的页面布局和风格，但它却是可读可写的。

下面的一个代码片段是一个有效的HTML5标记：

可是，怎么来读取这些数据呢？你当然可以遍历页面元素来读取你想要的属性，但jquery已经内置了方法来操作这些属性。使用jQuery的.data()方法来访问这些`"data-*"`属性。其中一个方法就是` .data(obj)`，这个方法是在 jQuery1.4.3版本后出现的，它能返回相应的data属性。

举个例子，你可以用下面的写法读取 `data-myid`属性值：

var myid= jQuery("#test").data('myid');
    console.log(myid);

你还可以在`"data-*" `属性里使用json语法，例如，如果你写出下面的html：

你可以通过js直接访问这个数据，通过json的key值，你能得到相应的value：

var gameStatus= jQuery("#test-json").data('test').game;
    console.log(gameStatus);

你也可以通过`.data(key,value)`方法直接给`"data-*" `属性赋值。一个重要的你要注意的事情是，这些`"data-*" `属性应该和它所在的元素有一定的关联，不要把它当成存放任意东西的存储工具。

通过支持html5的浏览器中的js代码也可以获取相应的值，例如：

获取js代码

var post = document.getElementsByTagName('div')[0];
    post.dataset; // DOMStringMap
    post.dataset.commentNum; // 10

需要注意的是，data-之后的以连字符分割的多个单词组成的属性，获取的时候使用驼峰风格。

补充：尽管`"data-*" `是HTML5才出现的属性，但jquery是通用的，所以，在非HTML5的页面或浏览器里，你仍然可以使用`.data(obj)`方法来操作`"data-*" `数据。