本文旨在帮助开发者解决在使用JavaScript代码持久化UTM参数时，链接被错误添加问号的问题。通过分析问题代码，找出问题根源，并提供修改后的代码示例，确保UTM参数仅在存在时才被添加到链接中，从而避免不必要的问号出现。
在使用JavaScript进行UTM参数持久化时，一个常见的问题是即使URL中没有UTM参数，代码仍然会向链接添加一个问号。这会导致不必要的URL修改，影响用户体验和数据分析的准确性。本文将分析导致此问题的原因，并提供解决方案。
问题分析
问题主要出在 decorateUrl 函数中，该函数负责将UTM参数添加到URL。原始代码无论 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中。
解决方案
要解决这个问题，我们需要修改 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('&');
}在这个修改后的版本中，我们首先检查 collectedQueryParams 的长度。如果长度为0，表示没有收集到任何UTM参数，函数直接返回原始URL，避免添加任何额外的符号。只有当 collectedQueryParams 包含至少一个元素时，才会添加 ? 或 & 符号，并将UTM参数添加到URL中。
完整代码示例
以下是包含修改后的 decorateUrl 函数的完整代码示例：
<script>
(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]);
}
})();
</script>注意事项
- 确保 domainsToDecorate 数组包含所有需要添加UTM参数的域名。
- queryParams 数组包含所有需要持久化的UTM参数。
- 此代码假定UTM参数位于 window.location.search 中。如果UTM参数位于其他位置，需要修改 getQueryParam 函数。
总结
通过修改 decorateUrl 函数，我们可以避免在没有UTM参数的情况下向链接添加不必要的问号。这有助于提高URL的整洁性，并确保数据分析的准确性。在实际应用中，请根据具体需求调整代码，并进行充分测试，确保其能够正常工作。
