如何使用 express-validator 验证输入字段中的输入是否必须包含种子词?
在 HTML 表单中,我们经常需要验证不同的类型。验证现有电子邮件,验证密码长度,验证确认密码,验证仅允许整数输入,这些是验证的一些示例。在某个输入字段中,我们经常需要验证输入,以便它必须包含一个种子词,即输入可以是任何东西(任何字符串)但必须包含一个特定的词(种子词)。我们还可以使用 express-validator 中间件验证这些输入字段以仅接受那些包含种子词的值。
安装 express-validator 的命令:
npm install express-validator
使用 express-validator 实现逻辑的步骤:
- 安装 express-validator 中间件。
- 创建一个validator.js 文件来编码所有的验证逻辑。
- 通过 validateInputField 验证输入:check(input field name) 并链上验证 contains(seed) 和 ' 。 '
- 如果想忽略大小写敏感添加选项对象参数 {ignoreCase:true}。默认情况下,ignoreCase 设置为 true。
- 使用路由中的验证名称(validateInputField)作为验证数组的中间件。
- 从 express-validator 中解构 'validationResult'函数以使用它来查找任何错误。
- 如果发生错误,则重定向到传递错误信息的同一页面。
- 如果错误列表为空,则授予用户后续请求的访问权限。
注意:这里我们使用本地或自定义数据库来实现逻辑,可以按照相同的步骤在MongoDB或MySql等常规数据库中实现逻辑。
示例:此示例说明如何验证输入字段以仅允许包含种子词的值。
文件名 - index.js
javascript
const express = require('express')
const bodyParser = require('body-parser')
const {validationResult} = require('express-validator')
const repo = require('./repository')
const { validatePlayerName } = require('./validator')
const formTemplet = require('./form')
const app = express()
const port = process.env.PORT || 3000
// The body-parser middleware to parse form data
app.use(bodyParser.urlencoded({extended : true}))
// Get route to display HTML form
app.get('/', (req, res) => {
res.send(formTemplet({}))
})
// Post route to handle form submission logic and
app.post(
'/info',
[validatePlayerName],
async (req, res) => {
const errors = validationResult(req)
if(!errors.isEmpty()) {
return res.send(formTemplet({errors}))
}
const {name, dept, event, pname} = req.body
// New record
await repo.create({
'Name':name,
'Department':dept,
'Event Name':event,
'Player Name':pname,
})
res.send(
'Registered Successfully for the event!!')
})
// Server setup
app.listen(port, () => {
console.log(`Server start on port ${port}`)
})
javascript
// Importing node.js file system module
const fs = require('fs')
class Repository {
constructor(filename) {
// Filename where datas are going to store
if(!filename) {
throw new Error(
'Filename is required to create a datastore!')
}
this.filename = filename
try {
fs.accessSync(this.filename)
} catch(err) {
// If file not exist it is created
// with empty array
fs.writeFileSync(this.filename, '[]')
}
}
// Get all existing records
async getAll() {
return JSON.parse(
await fs.promises.readFile(this.filename, {
encoding : 'utf8'
})
)
}
// Create new record
async create(attrs) {
// Fetch all existing records
const records = await this.getAll()
// All the existing records with new
// record push back to database
records.push(attrs)
await fs.promises.writeFile(
this.filename,
JSON.stringify(records, null, 2)
)
return attrs
}
}
// The 'datastore.json' file created at runtime
// and all the information provided via signup form
// store in this file in JSON format.
module.exports = new Repository('datastore.json')
javascript
const getError = (errors, prop) => {
try {
return errors.mapped()[prop].msg
} catch (error) {
return ''
}
}
module.exports = ({errors}) => {
return `
`
}
javascript
const {check} = require('express-validator')
const repo = require('./repository')
module.exports = {
validatePlayerName : check('pname')
// To delete leading and trailing space
.trim()
// Validate player name to accept only
// the string that contains the word 'jolite'
// ignorecase is an optional attribute
// and it is by default set to false if
// ignorecase attribute set to be true,
// it ignores the case sensitivity
// of the required seed word
.contains('jolite', { ignoreCase: true})
// Custom message
.withMessage(
"Player Name must contains the word 'jolite'")
}
文件名——repository.js:该文件包含创建本地数据库并与之交互的所有逻辑。
javascript
// Importing node.js file system module
const fs = require('fs')
class Repository {
constructor(filename) {
// Filename where datas are going to store
if(!filename) {
throw new Error(
'Filename is required to create a datastore!')
}
this.filename = filename
try {
fs.accessSync(this.filename)
} catch(err) {
// If file not exist it is created
// with empty array
fs.writeFileSync(this.filename, '[]')
}
}
// Get all existing records
async getAll() {
return JSON.parse(
await fs.promises.readFile(this.filename, {
encoding : 'utf8'
})
)
}
// Create new record
async create(attrs) {
// Fetch all existing records
const records = await this.getAll()
// All the existing records with new
// record push back to database
records.push(attrs)
await fs.promises.writeFile(
this.filename,
JSON.stringify(records, null, 2)
)
return attrs
}
}
// The 'datastore.json' file created at runtime
// and all the information provided via signup form
// store in this file in JSON format.
module.exports = new Repository('datastore.json')
文件名 - form.js:此文件包含显示表单以提交数据的逻辑。
javascript
const getError = (errors, prop) => {
try {
return errors.mapped()[prop].msg
} catch (error) {
return ''
}
}
module.exports = ({errors}) => {
return `
`
}
文件名 - validator.js:此文件包含所有验证逻辑(验证输入字段以仅允许包含种子词的值的逻辑)。
javascript
const {check} = require('express-validator')
const repo = require('./repository')
module.exports = {
validatePlayerName : check('pname')
// To delete leading and trailing space
.trim()
// Validate player name to accept only
// the string that contains the word 'jolite'
// ignorecase is an optional attribute
// and it is by default set to false if
// ignorecase attribute set to be true,
// it ignores the case sensitivity
// of the required seed word
.contains('jolite', { ignoreCase: true})
// Custom message
.withMessage(
"Player Name must contains the word 'jolite'")
}
文件名 - package.json
数据库:
输出:
表单提交成功后的数据库:
注意:我们在 form.js 文件中使用了一些 Bulma 类(CSS 框架)来设计内容。