Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (seongtaejeong at gmail.com)
홈페이지
첨부 파일
 

(시리즈 글이 9개 있습니다.)
.NET Framework: 351. JavaScriptSerializer, DataContractJsonSerializer, Json.NET
; https://www.sysnet.pe.kr/2/0/1391

.NET Framework: 661. Json.NET의 DeserializeObject 수행 시 속성 이름을 동적으로 바꾸는 방법
; https://www.sysnet.pe.kr/2/0/11224

.NET Framework: 756. JSON의 escape sequence 문자 처리 방식
; https://www.sysnet.pe.kr/2/0/11532

사물인터넷: 54. 아두이노 환경에서의 JSON 파서(ArduinoJson) 사용법
; https://www.sysnet.pe.kr/2/0/11766

.NET Framework: 1073. C# - JSON 역/직렬화 시 리플렉션 손실을 없애는 JsonSrcGen
; https://www.sysnet.pe.kr/2/0/12688

.NET Framework: 2087. .NET 6부터 SourceGenerator와 통합된 System.Text.Json
; https://www.sysnet.pe.kr/2/0/13214

.NET Framework: 2115. System.Text.Json의 역직렬화 시 필드/속성 주의
; https://www.sysnet.pe.kr/2/0/13342

닷넷: 2261. C# - 구글 OAuth의 JWT (JSON Web Tokens) 해석
; https://www.sysnet.pe.kr/2/0/13623

닷넷: 2265. C# - System.Text.Json의 기본적인 (한글 등에서의) escape 처리
; https://www.sysnet.pe.kr/2/0/13644




C# - System.Text.Json의 기본적인 (한글 등에서의) escape 처리

Json.NET의 경우,

Json.NET
; https://www.newtonsoft.com/json

아래의 한글이 포함된 문자열을 직렬화하면,

using Newtonsoft.Json;

namespace ConsoleApp2;

// Install-Package Newtonsoft.Json
internal class Program
{
    static void Main(string[] args)
    {
        MyClass mc = new MyClass { Name = "\"<테스트>\"", Age = 20 };
        string text = JsonConvert.SerializeObject(mc, Formatting.Indented);
        File.WriteAllText("data.json", text);
    }
}

public class MyClass
{
    public string Name { get; set; } = "";
    public int Age { get; set; } = 1;
}

이런 결과가 나옵니다.

{
  "Name": "\"<테스트>\"",
  "Age": 20
}

반면, .NET에 내장된 System.Text.Json을 사용하면

internal class Program
{
    static JsonSerializerOptions jsonOptions = new()
    {
        WriteIndented = true
    };

    static void Main(string[] args)
    {
        MyClass mc = new MyClass { Name = "\"<테스트>\"", Age = 20 };

        string txt = JsonSerializer.Serialize(mc, jsonOptions);
        File.WriteAllText("data.json", txt);
    }
}

이렇게 나옵니다.

{
  "Name": "\u0022\u003C\uD14C\uC2A4\uD2B8\u003E\u0022",
  "Age": 20
}

이에 대해서는 이미 마이크로소프트의 공식 문서에서 자세하게 설명하고 있습니다.

System.Text.Json을 사용하여 문자 인코딩을 사용자 지정하는 방법
; https://learn.microsoft.com/ko-kr/dotnet/standard/serialization/system-text-json/character-encoding

위의 문서에서 제시하는 가장 간단한 방법으로 "모든 문자 직렬화"가 있는데요, 이 옵션을 사용하면,

static JsonSerializerOptions jsonOptions = new()
{
    Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
    WriteIndented = true
};

이제 출력은 (Json.NET과 동일하게) 다음과 같이 바뀝니다.

{
  "Name": "\"<테스트>\"",
  "Age": 20
}

하지만, 이 옵션에는 (문서에 명시한) 보안 주의 사항이 있으므로 별로 마음에 들지 않는데요, 사실 우리가 원하는 것은 한글과 일반 영숫자만 escape 처리가 안 되는 정도면 만족할 수 있으므로 다음과 같이 선택적으로 Encoder를 구성해 지정하는 것도 좋은 선택입니다.

static JsonSerializerOptions jsonOptions = new()
{
    Encoder = JavaScriptEncoder.Create(
        UnicodeRanges.BasicLatin, // 일반 영숫자
        UnicodeRanges.HangulCompatibilityJamo, // 이하 한글 관련 문자
        UnicodeRanges.HangulJamo,
        UnicodeRanges.HangulJamoExtendedA,
        UnicodeRanges.HangulJamoExtendedB,
        UnicodeRanges.HangulSyllables
        ),
    WriteIndented = true
};

그럼 출력은 다시 이렇게 바뀝니다.

{
  "Name": "\u0022\u003C테스트\u003E\u0022",
  "Age": 20
}

보는 바와 같이 HTML 구분 문자를 모두 escape 처리하기 때문에 보안에 걸릴 걱정을 하지 않아도 됩니다.




만약, 일본어나 중국어 등에 대해서도 저런 escape 처리를 없애야 한다면 UnicodeRanges를 일일이 추가하기보다는 그냥 All을 선택하는 것도 좋습니다.

static JsonSerializerOptions jsonOptions = new()
{
    Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
    WriteIndented = true
};

그래도 HTML 구분 문자들은 여전히 escape 처리를 한다는 점에서 JavaScriptEncoder.UnsafeRelaxedJsonEscaping 옵션과는 다른 장점이 있습니다.

그나저나, 이 글을 쓰면서 예전에 겪었던 상황이 떠오르는군요. ^^

curl - json_parse_exception / Invalid UTF-8 start byte
; https://www.sysnet.pe.kr/2/0/12307

그 당시 json 데이터를 curl에서 보내기 위해 이런 식으로 구성했는데요,

curl -X POST "http://localhost:9200/_analyze" -H "Content-Type: application/json" -d "{ \"tokenizer\": \"nori_tokenizer\", \"text\": \"논쟁이 주를 이룹니다.\" }"

일일이 "\"" 글자를 escape 처리하는 것이 귀찮았는데 어찌 보면 System.Text.Json으로 저 Json 데이터를 구성했다면 문제가 없었을 것입니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]







[최초 등록일: ]
[최종 수정일: 6/13/2024]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13678정성태7/15/2024214VS.NET IDE: 191. Visual Studio 2022 - .NET 5 프로젝트를 Docker Support로 실행했을 때 오류
13677정성태7/15/2024214오류 유형: 916. MSBuild - CheckEolTargetFramework (warning NETSDK1138)
13676정성태7/14/2024214Linux: 75. gdb에서 glibc의 함수에 Breakpoint 걸기
13675정성태7/13/2024481C/C++: 166. C/C++ - DLL에서 template 함수를 export하는 방법파일 다운로드1
13674정성태7/13/2024481오류 유형: 915. Unhandled Exception: Microsoft.Diagnostics.NETCore.Client.ServerNotAvailableException: Unable to connect to Process
13673정성태7/11/2024525닷넷: 2274. C# 13 - 신규 이스케이프 시퀀스 '\e'파일 다운로드1
13672정성태7/10/2024521닷넷: 2273. IIS - (프로세스 종료 없는) AppDomain Recycle
13671정성태7/10/2024544오류 유형: 914. Package ca-certificates is not installed.
13669정성태7/9/2024728오류 유형: 913. C# - AOT StaticExecutable 정적 링킹 시 빌드 오류
13668정성태7/8/2024794개발 환경 구성: 716. Hyper-V - Ubuntu 22.04 Generation 2 유형의 VM 설치
13667정성태7/7/2024776닷넷: 2272. C# - 리눅스 환경에서의 Hyper-V Socket 연동 (AF_VSOCK)파일 다운로드1
13666정성태7/7/2024963Linux: 74. C++ - Vsock 예제 (Hyper-V Socket 연동)파일 다운로드1
13665정성태7/6/20241017Linux: 73. Linux 측의 socat을 이용한 Hyper-V 호스트와의 vsock 테스트파일 다운로드1
13663정성태7/5/20241005닷넷: 2271. C# - Hyper-V Socket 통신(AF_HYPERV, AF_VSOCK)의 VMID Wildcards 유형파일 다운로드1
13662정성태7/4/20241263닷넷: 2270. C# - WSL 2 VM의 VM ID를 알아내는 방법 - Host Compute System API파일 다운로드1
13661정성태7/3/2024991Linux: 72. g++ - 다른 버전의 GLIBC로 소스코드 빌드
13660정성태7/3/20241164오류 유형: 912. Visual C++ - Linux 프로젝트 빌드 오류
13659정성태7/1/20241176개발 환경 구성: 715. Windows - WSL 2 환경의 Docker Desktop 네트워크
13658정성태6/28/20241190개발 환경 구성: 714. WSL 2 인스턴스와 호스트 측의 Hyper-V에 운영 중인 VM과 네트워크 연결을 하는 방법 - 두 번째 이야기
13657정성태6/27/20241395닷넷: 2269. C# - Hyper-V Socket 통신(AF_HYPERV, AF_VSOCK)을 위한 EndPoint 사용자 정의
13656정성태6/27/20241335Windows: 264. WSL 2 VM의 swap 파일 위치
13655정성태6/24/20241447닷넷: 2269. C# - Win32 Resource 포맷 해석파일 다운로드1
13654정성태6/24/20241372오류 유형: 911. shutdown - The entered computer name is not valid or remote shutdown is not supported on the target computer.
13653정성태6/22/20241301닷넷: 2268. C# 코드에서 MAKEINTREOURCE 매크로 처리
13652정성태6/21/20241436닷넷: 2267. C# - Linux 환경에서 (Reflection 없이) DLL AssemblyFileVersion 구하는 방법파일 다운로드2
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...