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

비밀번호

댓글 작성자
 



2024-10-19 12시17분
What’s new in System.Text.Json in .NET 9
; https://devblogs.microsoft.com/dotnet/system-text-json-in-dotnet-9/
정성태

1  2  [3]  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13868정성태1/17/20253096Windows: 277. Hyper-V - Windows 11 VM의 Enhanced Session 모드로 로그인을 할 수 없는 문제
13867정성태1/17/20254038오류 유형: 943. Hyper-V에 Windows 11 설치 시 "This PC doesn't currently meet Windows 11 system requirements" 오류
13866정성태1/16/20254240개발 환경 구성: 739. Windows 10부터 바뀐 device driver 서명 방법
13865정성태1/15/20253930오류 유형: 942. C# - .NET Framework 4.5.2 이하의 버전에서 HttpWebRequest로 https 호출 시 "System.Net.WebException" 예외 발생
13864정성태1/15/20253888Linux: 114. eBPF를 위해 필요한 SELinux 보안 정책
13863정성태1/14/20253339Linux: 113. Linux - 프로세스를 위한 전용 SELinux 보안 문맥 지정
13862정성태1/13/20253601Linux: 112. Linux - 데몬을 위한 SELinux 보안 정책 설정
13861정성태1/11/20253907Windows: 276. 명령행에서 원격 서비스를 동기/비동기로 시작/중지
13860정성태1/10/20253590디버깅 기술: 216. WinDbg - 2가지 유형의 식 평가 방법(MASM, C++)
13859정성태1/9/20253941디버깅 기술: 215. Windbg - syscall 이후 실행되는 KiSystemCall64 함수 및 SSDT 디버깅
13858정성태1/8/20254099개발 환경 구성: 738. PowerShell - 원격 호출 시 "powershell.exe"가 아닌 "pwsh.exe" 환경으로 명령어를 실행하는 방법
13857정성태1/7/20254124C/C++: 187. Golang - 콘솔 응용 프로그램을 Linux 데몬 서비스를 지원하도록 변경파일 다운로드1
13856정성태1/6/20253706디버깅 기술: 214. Windbg - syscall 단계까지의 Win32 API 호출 (예: Sleep)
13855정성태12/28/20244438오류 유형: 941. Golang - os.StartProcess() 사용 시 오류 정리
13854정성태12/27/20244530C/C++: 186. Golang - 콘솔 응용 프로그램을 NT 서비스를 지원하도록 변경파일 다운로드1
13853정성태12/26/20244012디버깅 기술: 213. Windbg - swapgs 명령어와 (Ring 0 커널 모드의) FS, GS Segment 레지스터
13852정성태12/25/20244460디버깅 기술: 212. Windbg - (Ring 3 사용자 모드의) FS, GS Segment 레지스터파일 다운로드1
13851정성태12/23/20244223디버깅 기술: 211. Windbg - 커널 모드 디버깅 상태에서 사용자 프로그램을 디버깅하는 방법
13850정성태12/23/20244713오류 유형: 940. "Application Information" 서비스를 중지한 경우, "This file does not have an app associated with it for performing this action."
13849정성태12/20/20244860디버깅 기술: 210. Windbg - 논리(가상) 주소를 Segmentation을 거쳐 선형 주소로 변경
13848정성태12/18/20244806디버깅 기술: 209. Windbg로 알아보는 Prototype PTE파일 다운로드2
13847정성태12/18/20244824오류 유형: 939. golang - 빌드 시 "unknown directive: toolchain" 오류 빌드 시 이런 오류가 발생한다면?
13846정성태12/17/20245038디버깅 기술: 208. Windbg로 알아보는 Trans/Soft PTE와 2가지 Page Fault 유형파일 다운로드1
13845정성태12/16/20244512디버깅 기술: 207. Windbg로 알아보는 PTE (_MMPTE)
13844정성태12/14/20245186디버깅 기술: 206. Windbg로 알아보는 PFN (_MMPFN)파일 다운로드1
13843정성태12/13/20244377오류 유형: 938. Docker container 내에서 빌드 시 error MSB3021: Unable to copy file "..." to "...". Access to the path '...' is denied.
1  2  [3]  4  5  6  7  8  9  10  11  12  13  14  15  ...