멋진 커뮤니티 모듈


JavaScript에서 데이터의 유효성을 검사 하는 간단하고 구성 가능한 방법 입니다.



사용법이유원리데모예제문서



Superstruct를 사용하면 인터페이스를 쉽게 정의하고 이에 대해 JavaScript 데이터를 검증할 수 있습니다. 유형 주석 API는 Typescript , Flow , GoGraphQL 에서 영감을 받아 친숙하고 이해하기 쉬운 API를 제공합니다.

그러나 Superstruct는 런타임에 데이터를 검증하도록 설계되었으므로 사용자 또는 최종 사용자를 위해 자세한 런타임 오류를 발생(또는 반환)합니다.이는 REST 또는 GraphQL API에서 임의의 입력을 수락하는 것과 같은 상황에서 특히 유용합니다.하지만 사용할 수도 있습니다. 필요할 때 런타임에 내부 데이터 구조의 유효성을 검사합니다.


Usage

Superstruct struct는 특정 스키마에 대해 데이터의 유효성을 검사할 수 있는 구조체를 생성하기 위해 팩토리를 내보냅니다 .

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
import { struct } from 'superstruct' const Article = struct({ id: 'number', title: 'string', is_published: 'boolean?', tags: ['string'], author: { id: 'number', }, }) const data = { id: 34, title: 'Hello World', tags: ['news', 'features'], author: { id: 1, }, } const article = Article(data) // This will throw when the data is invalid, and return the data otherwise. // If you'd rather not throw, use `Struct.validate()` or `Struct.test()`.

모든 기본 JavaScript 유형을 즉시 인식할 수 있지만 superstruct내보내기 를 사용하여 애플리케이션 요구 사항에 따라 고유한 사용자 정의 데이터 유형을 정의할 수도 있습니다 .

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
import { superstruct } from 'superstruct' import isUuid from 'is-uuid' import isEmail from 'is-email' const struct = superstruct({ types: { uuid: value => isUuid.v4(value), email: value => isEmail(value) && value.length < 256, }, }) const User = struct({ id: 'uuid', email: 'email', is_admin: 'boolean?', }) const data = { id: 'c8d63140-a1f7-45e0-bfc6-df72973fea86', email: 'jane@example.com', } const user = User(data)

Superstruct는 목록 또는 스칼라 구조체 정의, 기본값 적용, 구조체 내부 구성, 오류를 던지는 대신 오류 반환 등과 같은 더 복잡한 사용 사례도 지원합니다. 자세한 내용은 전체 문서 를 참조하십시오 .


Why?

기존 유효성 검사가 많이 있습니까? 라이브러리 joi- express-validator, validator.js, yup, ajv, is-my-json-valid... 그러나 코드베이스를 유지 관리하기 어렵게 만드는 많은 연체를 나타냅니다 ...

  • 자세한 오류를 노출하지 않으며 많은 유효성 검사기가 이유에 대한 세부 정보 없이 단순히 문자열 전용 오류 또는 부울 값을 반환하므로 최종 사용자에게 도움이 되도록 오류를 사용자 지정하기가 어렵습니다.

  • 그들은 사용자 정의 유형을 어렵게 만든다. 많은 유효성 검사기와 함께 제공되는 내장 그들이 확인하고 새로운 유형을 정의하는 API를 복잡하게 알 수있는 방법 등등 이메일, URL을 UUID가 같은 종류.

  • 단일 정보 소스를 권장하지 않습니다. 많은 기존 API에서 사용자 정의 데이터 유형을 계속해서 재정의하도록 권장하며, 소스는 전체 코드 기반에 분산되어 있습니다.

  • 그들은 오류를 던지지 않습니다. 많은 사람들이 실제로 오류를 던지지 않으므로 모든 곳을 감싸야 합니다. 콜백 시대에는 유용하지만 throw최신 JavaScript에서 사용하지 않으면 코드가 훨씬 더 복잡해집니다.

  • 많은 유효성 검사기는 스키마를 일반 JavaScript 개체로 정의 합니다. 즉, 스키마 논리의 구문 분석을 유효성 검사 시간에 위임하므로 훨씬 느려집니다.

  • 다른 문제와 밀접하게 연결되어 있습니다. 많은 유효성 검사기가 Express 또는 기타 프레임워크와 밀접하게 연결되어 있어 코드 기반 전체에서 재사용할 수 없는 일회성 혼란스러운 코드가 생성됩니다.

  • 그들은 JSON Schema를 사용합니다. 오해하지 마세요 . JSON Schema 유용 할 수 있습니다. 하지만 HATEOAS와 비슷합니다. 일반적으로 필요한 것보다 훨씬 더 복잡하고 이점을 사용하지 않습니다.(죄송합니다. .)

물론 모든 유효성 검사 라이브러리가 이러한 문제를 모두 겪는 것은 아니지만 대부분은 적어도 한 가지 이상을 나타냅니다. 이전에 이 문제를 겪은 적이 있다면 Superstruct를 좋아할 것입니다.

Superstruct가 이러한 문제를 해결하는 방법을 알려줍니다...


Principles

  1. 사용자 정의 가능한 유형 Superstruct의 장점은 애플리케이션에 고유하고 단일 위치 에 정의된 전체 사용자 정의 데이터 유형 세트를 쉽게 정의 하여 요구사항을 완벽하게 제어할 수 있다는 것입니다.

  2. 의견이 없는 기본값 Superstruct는 기본 JavaScript 유형과 함께 제공되며 다른 모든 것은 사용자 정의할 수 있으므로 애플리케이션의 요구와 다른 "코어"에서 내린 결정을 무시하기 위해 싸울 필요가 없습니다.

  3. 구성 가능한 인터페이스: Superstruct 인터페이스는 구성할 수 있으므로 일반적으로 반복되는 데이터 조각을 구성 요소로 분해하고 구성하여 더 복잡한 개체를 구성할 수 있습니다.

  4. 간결한 스키마 Superstruct의 스키마는 매우 간결하고 표현력이 풍부하도록 설계되어 매우 쉽게 읽고 쓸 수 있으므로 전체 데이터 유효성 검사를 수행할 수 있습니다.

  5. 컴파일된 유효성 검사기: Superstruct는 스키마를 컴파일하는 작업을 미리 수행하므로 핫 코드 경로에서 유효성 검사 함수에 대한 모든 호출에 대해 값비싼 작업을 수행하는 데 시간을 소비하지 않습니다.

  6. 유용한 오류 : Superstruct가 던지는 오류에는 이를 응용 프로그램별 오류로 쉽게 변환하는 데 필요한 모든 정보가 포함되어 있으며, 이는 최종 사용자에게 더 유용한 오류를 의미합니다!

  7. 친숙한 API Superstruct API는 Typescript , Flow , GoGraphQL 에서 크게 영감을 얻었습니다 .이 중 하나에 익숙하다면 스키마 정의 API를 사용하는 것이 매우 자연스럽게 느껴지므로 빠르게 시작할 수 있습니다.


Demo

API 작동 방식에 대한 아이디어를 얻거나 사용 사례를 빠르게 확인하려면 JSFiddle 에서 라이브 데모를 시도하십시오 .

데모 스크린샷.


Examples

Superstruct의 API는 매우 유연하여 서버와 브라우저의 다양한 사용 사례에 사용할 수 있습니다. 다음은 일반적인 패턴의 몇 가지 예입니다...


Documentation

시작 가이드를 읽고 Superstruct의 작동 방식을 숙지한 후 전체 API 참조에서 구조체, 유형 및 오류에 대한 자세한 정보를 확인하세요...


License

이 패키지는 MIT-licensed.