本文旨在解决在使用JavaScript持久化UTM参数时，链接在没有UTM参数的情况下被意外添加问号的问题。通过分析问题代码，找出错误原因，并提供修正后的代码示例，确保只有当存在UTM参数时，链接才会被添加相应的参数。同时，强调了代码的健壮性和可维护性，避免不必要的修改和潜在的错误。
在使用JavaScript持久化UTM参数时，一个常见的问题是，即使URL中没有UTM参数，代码也可能会在链接末尾添加一个多余的问号。这不仅影响用户体验，还可能对网站分析造成干扰。本文将分析导致此问题的原因，并提供解决方案。
问题分析
问题的根源在于decorateUrl函数中，无论collectedQueryParams是否包含任何元素，都会无条件地添加问号或&符号。
function decorateUrl(urlToDecorate) {
urlToDecorate = (urlToDecorate.indexOf('?') === -1) ? urlToDecorate + '?' : urlToDecorate + '&';
var collectedQueryParams = [];
for (var queryIndex = 0; queryIndex < queryParams.length; queryIndex++) {
if (getQueryParam(queryParams[queryIndex])) {
collectedQueryParams.push(queryParams[queryIndex] + '=' + getQueryParam(queryParams[queryIndex]))
}
}
return urlToDecorate + collectedQueryParams.join('&');
}这段代码的逻辑是，如果URL中没有问号，就添加一个问号；否则，添加一个&符号。然后，它将收集到的UTM参数添加到URL末尾。然而，即使没有收集到任何UTM参数，问号或&符号仍然会被添加，导致了问题。
解决方案
为了解决这个问题，我们需要修改decorateUrl函数，使其只有在collectedQueryParams包含元素时才添加问号或&符号。以下是修改后的代码：
function decorateUrl(urlToDecorate) {
var collectedQueryParams = [];
for (var queryIndex = 0; queryIndex < queryParams.length; queryIndex++) {
if (getQueryParam(queryParams[queryIndex])) {
collectedQueryParams.push(queryParams[queryIndex] + '=' + getQueryParam(queryParams[queryIndex]))
}
}
if(collectedQueryParams.length === 0){
return urlToDecorate;
}
//only add the ? if we have params AND if there isn't already one
urlToDecorate = (urlToDecorate.indexOf('?') === -1) ? urlToDecorate + '?' : urlToDecorate + '&';
return urlToDecorate + collectedQueryParams.join('&');
}这段代码首先收集UTM参数。然后，它检查collectedQueryParams的长度。如果长度为0，表示没有UTM参数需要添加，函数直接返回原始URL，避免添加多余的问号。只有当collectedQueryParams包含至少一个元素时，才会添加问号或&符号，并将UTM参数添加到URL末尾。
完整代码示例
(function() {
var domainsToDecorate = [
'example.com'
],
queryParams = [
'utm_medium', //add or remove query parameters you want to transfer
'utm_source',
'utm_campaign',
'utm_content',
'utm_term'
];
// do not edit anything below this line
var links = document.querySelectorAll('a');
// check if links contain domain from the domainsToDecorate array and then decorates
for (var linkIndex = 0; linkIndex < links.length; linkIndex++) {
for (var domainIndex = 0; domainIndex < domainsToDecorate.length; domainIndex++) {
if (links[linkIndex].href.indexOf(domainsToDecorate[domainIndex]) > -1 && links[linkIndex].href.indexOf("#") === -1) {
links[linkIndex].href = decorateUrl(links[linkIndex].href);
}
}
}
// decorates the URL with query params
function decorateUrl(urlToDecorate) {
var collectedQueryParams = [];
for (var queryIndex = 0; queryIndex < queryParams.length; queryIndex++) {
if (getQueryParam(queryParams[queryIndex])) {
collectedQueryParams.push(queryParams[queryIndex] + '=' + getQueryParam(queryParams[queryIndex]))
}
}
if(collectedQueryParams.length === 0){
return urlToDecorate;
}
//only add the ? if we have params AND if there isn't already one
urlToDecorate = (urlToDecorate.indexOf('?') === -1) ? urlToDecorate + '?' : urlToDecorate + '&';
return urlToDecorate + collectedQueryParams.join('&');
}
// a function that retrieves the value of a query parameter
function getQueryParam(name) {
if (name = (new RegExp('[?&]' + encodeURIComponent(name) + '=([^&]*)')).exec(window.location.search))
return decodeURIComponent(name[1]);
}
})();注意事项
- 确保domainsToDecorate数组包含所有需要添加UTM参数的域名。
- queryParams数组包含所有需要持久化的UTM参数。
- 在实际部署之前，务必在测试环境中验证代码的正确性。
- 考虑使用更健壮的URL解析和构建库，例如URLSearchParams，以处理更复杂的URL结构。
总结
通过修改decorateUrl函数，我们可以避免在没有UTM参数的情况下向链接添加多余的问号。这不仅提高了用户体验，还确保了网站分析数据的准确性。在编写JavaScript代码时，务必考虑各种边界情况，并进行充分的测试，以确保代码的健壮性和可靠性。
