Módulo url de Node.js
En Node.js,urlel módulo es un módulo integrado que se utiliza para procesar y parsear URL (Localizador Uniforme de Recursos). Proporciona una serie de métodos prácticos para parsear, formatear y procesar cadenas URL con facilidad.
URL (Uniform Resource Locator) es una dirección en Internet que se utiliza para identificar y localizar recursos, por ejemplo:
https://www.example.com:8080/path/to/resource?query=string#hash
Métodos principales
Método url.parse()
url.parse()El método se utiliza para parsear una cadena URL en un objeto URL.
Ejemplo
const urlString = 'https://www.example.com:8080/path/to/resource?query=string#hash';
const parsedUrl = url.parse(urlString);
console.log(parsedUrl);
El resultado de salida contendrá las siguientes propiedades:
protocol: protocolo (por ejemplo, 'https:')host: nombre de host y puerto (por ejemplo, 'www.example.com:8080')hostname: nombre de host (por ejemplo, 'www.example.com')port: número de puerto (por ejemplo, '8080')pathname: parte de la ruta (por ejemplo, '/path/to/resource')query: cadena de consulta (por ejemplo, 'query=string')hash: identificador de fragmento (por ejemplo, '#hash')
Método url.format()
url.format()El métodoparse()por el contrario, convierte el objeto URL en una cadena.
Ejemplo
const urlObject = {
protocol: 'https:',
host: 'www.example.com:8080',
pathname: '/path/to/resource',
query: { query: 'string' },
hash: '#hash'
};
const formattedUrl = url.format(urlObject);
console.log(formattedUrl);
// Salida: https://www.example.com:8080/path/to/resource?query=string#hash
Método url.resolve()
url.resolve()El método se utiliza para resolver una URL de destino relativa a la URL base.
Ejemplo
const baseUrl = 'https://www.example.com/path/';
const relativeUrl = 'to/resource';
const resolvedUrl = url.resolve(baseUrl, relativeUrl);
console.log(resolvedUrl);
// Salida: https://www.example.com/path/to/resource
Estructura del objeto URL
Un objeto URL completo generalmente contiene las siguientes propiedades:
- Protocolo- como 'http:' o 'https:'
- Información de autenticación (auth)- contiene nombre de usuario y contraseña
- Host- nombre de host y número de puerto
- Nombre de host (hostname)- solo el nombre de host
- Puerto (port)- número de puerto
- Ruta (pathname)- ruta del recurso
- Cadena de consulta (search)- cadena de consulta que comienza con '?'
- Parámetros de consulta (query)- resultado del parseo de la cadena de consulta
- Identificador de fragmento (hash)- identificador de fragmento que comienza con '#'
Nueva API de URL
Node.js también proporciona una nueva API basada en el estándar WHATWG URL:
Clase URL
Ejemplo
const myUrl = new URL('https://www.example.com:8080/path/to/resource?query=string#hash');
console.log(myUrl.protocol); // 'https:'
console.log(myUrl.hostname); // 'www.example.com'
console.log(myUrl.port); // '8080'
console.log(myUrl.pathname); // '/path/to/resource'
console.log(myUrl.search); // '?query=string'
console.log(myUrl.hash); // '#hash'
Clase URLSearchParams
URLSearchParamsProporciona métodos convenientes para manejar cadenas de consulta:
Ejemplo
const myUrl = new URL('https://example.com/?name=John&age=30');
const params = new URLSearchParams(myUrl.search);
// Obtener parámetro
console.log(params.get('name')); // 'John'
console.log(params.get('age')); // '30'
// Agregar parámetro
params.append('city', 'New York');
// Eliminar parámetro
params.delete('age');
// Convertir a cadena
console.log(params.toString()); // 'name=John&city=New+York'
Casos de uso prácticos
1. Parsear la URL de una solicitud
Parsear la URL de la solicitud del cliente en un servidor HTTP:
Ejemplo
const url = require('url');
const server = http.createServer((req, res) => {
const parsedUrl = url.parse(req.url, true);
console.log('Path:', parsedUrl.pathname);
console.log('Query:', parsedUrl.query);
res.end('URL parsed successfully');
});
server.listen(3000);
2. Construir endpoints de API
Usar el módulo URL para construir endpoints de API RESTful:
Ejemplo
const url = require('url');
const server = http.createServer((req, res) => {
const parsedUrl = url.parse(req.url, true);
const path = parsedUrl.pathname;
if (path === '/api/users') {
// Manejar solicitudes relacionadas con el usuario
res.end(JSON.stringify({ users: ['John', 'Jane'] }));
} else if (path === '/api/products') {
// Manejar solicitudes relacionadas con productos
res.end(JSON.stringify({ products: ['Phone', 'Laptop'] }));
} else {
res.statusCode = 404;
res.end('Not Found');
}
});
server.listen(3000);
3. Manejar parámetros de consulta
Ejemplo
const url = require('url');
const server = http.createServer((req, res) => {
const parsedUrl = url.parse(req.url, true);
const query = parsedUrl.query;
if (parsedUrl.pathname === '/search') {
const keyword = query.q || '';
const page = parseInt(query.page) || 1;
res.end(`Searching for "${keyword}" on page ${page}`);
}
});
server.listen(3000);
Mejores prácticas
- Validar siempre la URL- Al manejar URLs proporcionadas por el usuario, valide siempre su validez
- Usar la nueva API- Priorice el uso de WHATWG URL API, ya que se ajusta mejor a los estándares modernos
- Manejar excepciones- Use try-catch para manejar los errores que puedan surgir al parsear URLs
- Codificar caracteres especiales- Use
encodeURIComponent()para codificar los caracteres especiales en los parámetros de consulta - Consideraciones de seguridad- Al manejar redirecciones, valide la URL de destino para prevenir vulnerabilidades de redirección abierta
Ejemplo
function isValidRedirect(url) {
const allowedDomains = ['example.com', 'trusted-site.com'];
const parsedUrl = new URL(url);
return allowedDomains.includes(parsedUrl.hostname);
}
Al dominar elurlmódulo de Node.js, puedes manejar fácilmente varias operaciones relacionadas con URL y construir aplicaciones de red más robustas y seguras.
Módulos integrados de Node.js