Mongoose: ObjectId를 검증하는 가장 좋은 방법

같은 문제가 있습니다. mongoose.Schema.ObjectId.isValid() 및 mongoose.Types.ObjectId.isValid()를 시도했지만 해당 속성에는 isValid 메서드가 없습니다. 이 문제를 어떻게 해결하셨습니까? 나는 또한 mongodb에 하나가 있고 또 다른 옵션으로 정규식도 있음을 알 수 있습니다. 정규식을 사용하지 않거나 요구하지 않는 것을 선호합니다('mongodb')

이것은 나를 위해 작동합니다.

var 몽구스 = 필요('./노드 모듈/몽구스');
console.log(mongoose.Types.ObjectId.isValid);
// [함수: isValid]
console.log(mongoose.Types.ObjectId.isValid('53cb6b9b4f4ddef1ad47f943'));
// 진실
console.log(mongoose.Types.ObjectId.isValid('bleurgh'));
// 거짓

덧붙여서 mongodb의 메서드는 bson lib 메서드로 null이 아닌지, 12자 또는 24자 16진 문자열을 확인합니다. 다음과 같은 정규식입니다.

var checkForHexRegExp = 새로운 RegExp("^[0-9a-fA-F]{24}$");

그래서 그것이 거기에서 사용된다면 너무 해킹 될 수 없습니다.

문자열에 12자가 포함된 경우 sValid()는 항상 True를 반환합니다.

console.log(mongoose.Types.ObjectId.isValid("zzzzzzzzzzzz")); // 진실

"zzzzzzzzzzzz"는 기술적으로 유효한 ObjectId이기 때문에 - 개체 ID의 유일한 정의 기능은 길이가 12바이트라는 것입니다. mongodb/js-bson#112를 참조하세요. 길이가 12인 JS 문자열에는 12바이트의 모듈로 유니코드가 있습니다. 길이가 24인 16진수 문자열을 확인하려면 문자열이 /^[a-fA-F0-9]{24}$/ 와 일치하는지 확인하세요.

"zzzzzzzzzzzz"는 유효한 ObjectId가 아닙니다. 예를 들어 Mongo 셸 목록(mongodb 버전 - 3.0.2):

> ObjectId('zzzzzzzzzzzz')
2015-04-29T18:05:20.705+0300 E QUERY    Error: invalid object id: length
    at (shell):1:1
> ObjectId('zzzzzzzzzzzzzzzzzzzzzzzz')
2015-04-29T18:06:09.773+0300 E QUERY    Error: invalid object id: not hex
    at (shell):1:1
> ObjectId('ffffffffffff')
2015-04-29T18:09:17.303+0300 E QUERY    Error: invalid object id: length
    at (shell):1:1
> ObjectId('ffffffffffffffffffffffff')
ObjectId("ffffffffffffffffffffffff")

mongodb 셸의 ObjectId 생성자는 16진 문자열만 허용하도록 작성되었기 때문입니다. BSON 유형 ObjectId가 아닌 편의상 mongo 셸의 제한 사항입니다. 16진 문자열이 일반적으로 ObjectIds가 표현되는 방식이라는 점을 감안할 때 이것은 다소 직관적이지 않은 경우이지만, 마음에 들지 않으면 정규식 /^[a-fA-F0-9]{24}$/ 을 사용하십시오. :)

String이 아닌 ObjectId 자체에 대해 isValid 를 수행하려고 할 때 왜 false가 발생합니까? ObjectId가 유효한 ObjectId이므로 true를 반환하지 않아야 합니까? 그것은 말이 되지 않습니다 -- isValid 에 전달되는 객체라면 .toString() 를 호출할 수 있습니까?

@niftylettuce 댓글은 #3365에서 환영합니다. 지금은 사람들이 몽구스에서 ObjectIds를 생각하는 방식과 정확히 일치하지 않는 bson 패키지의 ObjectId.isValid() 함수 로 연기합니다. 그래도 ObjectId가 주어지면 true를 반환하기 위해 PR을 열겠습니다. 이는 완벽하게 합리적으로 보입니다.

여기에서 약간의 오래된 문제로 돌아가서 ... @atcwells 솔루션 mongoose.Types.ObjectId.isValid('53cb6b9b4f4ddef1ad47f943') 은 저에게 충분히 잘 작동하지만 컨트롤러가 개체 ID가 유효한지 여부를 확인하도록 하는 것은 여전히 ​​약간 해킹된 것처럼 보입니다. 확실히 잘못된 형식의 ID를 서버에 보내고 충돌을 일으키지 않기를 원하는 것은 꽤 일반적인 사용 사례입니다.

이상적으로는 콜백의 err 에 무언가를 반환하여 올바르게 처리하고 컨트롤러를 사용하여 올바른 HTTP 상태를 보낼 수 있습니다.

이것이 핵심에서 유용한 기능 이 아닌 유스 케이스가 있습니까? 그렇지 않은 경우 플러그인을 만들 수 있습니다. 나는 빠른 검색을했고 작업을 수행하는 아무 것도없는 것 같습니다. https://github.com/CampbellSoftwareSolutions/mongoose-id-validator 는 ID가 실제로 존재하는지 확인하기위한 것입니다. 우리는 여기에서 하고 싶습니다 – 우리는 단지 우리가 잡히지 않는 오류를 생성하지 않도록 하기를 원합니다.

지금 내 Express 컨트롤러에서 ObjectId가 포함된 요청(예: GET to https://myproject/organisations/ {id})을 할 때마다 다음과 같은 작업을 수행해야 합니다.

if( !mongoose.Types.ObjectId.isValid(id) ){
    return res.sendStatus(400); // They didn't send an object ID
  }

... 그 전에 Organisation.findOne();

꽤 상용구 같습니다. 누군가가 시작해야 할 올바른 방향을 알려줄 수 있다면 플러그인이나 무언가를 작성하게 되어 기쁩니다. 실제로 스키마 문제가 아니기 때문에 플러그인처럼 보이지 않습니다 ...

@shankiesan 당신은 그렇게 할 필요가 없습니다, mongoose는 ID가 유효하지 않은 경우 쿼리 약속을 거부합니다.

var assert = require('assert');
var mongoose = require('mongoose');
var Schema = mongoose.Schema;

mongoose.connect('mongodb://localhost/test');
mongoose.set('debug', true);

var MyModel = mongoose.model('test', new Schema({ name: String }));

MyModel.findOne({ _id: 'invalid' }).exec().catch(error => console.error('error', error));

산출:

$ node gh-1959.js 
error { CastError: Cast to ObjectId failed for value "invalid" at path "_id"
    at MongooseError.CastError (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/error/cast.js:19:11)
    at ObjectId.cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/schema/objectid.js:147:13)
    at ObjectId.castForQuery (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/schema/objectid.js:187:15)
    at cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/cast.js:174:32)
    at Query.cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2563:10)
    at Query.findOne (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:1239:10)
    at /home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2163:21
    at new Promise.ES6 (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/promise.js:45:3)
    at Query.exec (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2156:10)
    at Object.<anonymous> (/home/val/Workspace/10gen/troubleshoot-mongoose/gh-1959.js:10:37)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
  message: 'Cast to ObjectId failed for value "invalid" at path "_id"',
  name: 'CastError',
  kind: 'ObjectId',
  value: 'invalid',
  path: '_id',
  reason: undefined }
^C
$ 

또한 다시: 플러그인 http://thecodebarbarian.com/2015/03/06/guide-to-mongoose-plugins

아, 내가 얼마나 머펫이었는지! 물론 거절당한 약속을 처리하십시오 ... 아아, 내 두뇌. 감사 합니다 @vkarpov15

프라미스가 너무 골치 아픈 경우에도 콜백이 작동합니다 MyModel.findOne({ _id: 'invalid' }).exec(error => console.error('error', error)); :)

Valeri가 말한 위의 12바이트에서 이미 명확하지 않은 경우 ObjectId.isValid() 를 사용하지 마십시오. 방금 이것으로 꽤 잘 구워졌습니다.
ObjectId.isValid('The Flagship') === true

@atcwells 만약 당신이 그 비트를 포함하도록 당신의 높은 찬성 의견을 업데이트할 수 있다면 나는 당신이 말한 것에 기초하여 처음에 그것을 하고 있었기 때문에 다른 사람들이 그것을 고마워할 것이라고 생각합니다: ObjectId.isValid('The Flagship') === true

재미있는 부분은 다음과 같습니다.
다음 문장은 true를 반환합니다.
mongoose.Types.ObjectId.isValid("남아프리카 공화국")

내가 (현재) 하고 있는 것은 promise catch에서 오류 유형을 확인하는 것입니다. 'ObjectId'인 경우 404를 반환합니다. API/웹 서비스 소비자에게 리소스를 찾을 수 없거나 존재하지 않기 때문에 404를 반환합니다.

예를 참조하십시오.

  Widget.findByIdAndRemove(resourceId)
    .then((result) => {
      if (!result) {
        let error = new Error('Resource not found');
        error.status = 404;
        next(error);
      } else {
        res.redirect(303, '/');
      }
    })
    .catch((error) => {
      if (error.kind === 'ObjectId') {
        let error = new Error('Resource not found');
        error.status = 404;

        next(error);
      } else {
        next(error);
      }
    });

업데이트:
컨트롤러의 각 경로 처리기에 이것을 추가하는 대신. 전역 catch all 처리기에 추가하고 있습니다.

예를 참조하십시오.

app.use(function(err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  if (err.kind === 'ObjectId') {
    err.status = 404;
  }

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

스키마에서 유효성을 검사할 수 있습니까? 모범 사례가 반복되는 것은 아니지만 캐스트 오류 이벤트를 기록하고 싶습니다.

mongoose가 MongoDB만 처리할 때 isValid에 대해 정규식 /^[a-fA-F0-9]{24}$/를 구현할 수 없는 이유는 무엇입니까? 너무 혼란스럽습니다. 우리는 문제를 디버깅하는 데 한 시간을 할애했으며 결코 알아차리지 못할 어리석은 일이 되었습니다.

이 npm 패키지를 사용하는 것이 좋습니다. https://www.npmjs.com/package/valid-objectid
그것은 완벽하게 작동합니다

이에 대한 해결 방법을 만들었습니다.

function isObjectId(value) {
  try {
      const { ObjectId } = mongoose.Types;
      const asString = value.toString(); // value is either ObjectId or string or anything
      const asObjectId = new ObjectId(asString);
      const asStringifiedObjectId = asObjectId.toString();
      return asString === asStringifiedObjectId;
    } catch (error) {
      return false;
    }
}

@mstmustisnt 값이 "123"이면 오류가 발생합니다.

누군가에게 도움이 될 수 있도록 위의 ObjectId.isValid() 접근 방식을 적용했습니다. 내 사용 사례에서는 ID 또는 url-slug로 리소스를 얻을 수 있기를 원하기 때문입니다. 예:

GET /users/59f5e7257a92d900168ce49a ... 또는 ...
GET /users/andrew-shankie

...내 컨트롤러에서 이것이 잘 작동한다는 것을 발견했습니다.

  const { id } = req.params;

  const query = {
    $or: [{ slug: id }],
  };

  if (mongoose.Types.ObjectId.isValid(id)) query.$or.push({ _id: id });

  User.findOne(query)
    .exec((err, user) => { ... }

이 경우 12바이트 문자열은 여전히 ​​유효한 개체 ID이며, 이를 검색하면 오류가 발생하지 않고 길이가 0인 배열이 반환됩니다. 그리고 $or 쿼리를 사용하고 있기 때문에 URL 슬러그(내 다른 가능한 옵션)로 검색합니다.

가장 우아한 솔루션은 아니지만 저에게 효과적입니다.

@victorbadila 네, 맞습니다. 나는 단지 힌트를 주었다. 내 의견을 편집하고 실제로 내가 실제로 사용하는 코드를 배치합니다.

validator.js 에는 isMongoId 메소드가 내장되어 있습니다.

mongoose를 사용할 때마다 항상 몇 가지 정적 도우미 메서드를 사용하여 확장합니다.

const mongoose = require('mongoose');
const {Types: {ObjectId}} = mongoose;

//Helper to check if an ID is an object ID
mongoose.isObjectId = function(id) {
  return (id instanceof ObjectId);
};

//Helper to validate a string as object ID
mongoose.isValidObjectId = function(str) {
  if (typeof str !== 'string') {
    return false;
  }
  return str.match(/^[a-f\d]{24}$/i);
};

이것을 데이터베이스 초기화 스크립트의 일부로 실행할 수 있으므로 앱에서 메서드를 항상 사용할 수 있습니다.

ObjectId.isValid(id)가 true이면 (new ObjectId(id).toString()) 의 값과 id를 판단할 수 있습니다.

const mongoose = require('mongoose');
const {Types: {ObjectId}} = mongoose;
const validateObjectId = (id) => ObjectId.isValid(id) && (new ObjectId(id)).toString() === id;