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)
13713정성태8/16/20242956개발 환경 구성: 721. WSL 2에서의 Hyper-V Socket 연동
13712정성태8/14/20242890개발 환경 구성: 720. Synology NAS - docker 원격 제어를 위한 TCP 바인딩 추가
13711정성태8/13/20243366Linux: 77. C# / Linux - zombie process (defunct process)파일 다운로드1
13710정성태8/8/20243632닷넷: 2294. C# 13 - (6) iterator 또는 비동기 메서드에서 ref와 unsafe 사용을 부분적으로 허용파일 다운로드1
13709정성태8/7/20243500닷넷: 2293. C# - safe/unsafe 문맥에 대한 C# 13의 (하위 호환을 깨는) 변화파일 다운로드1
13708정성태8/7/20243164개발 환경 구성: 719. ffmpeg / YoutubeExplode - mp4 동영상 파일로부터 Audio 파일 추출
13707정성태8/6/20243684닷넷: 2292. C# - 자식 프로세스의 출력이 4,096보다 많은 경우 Process.WaitForExit 호출 시 hang 현상파일 다운로드1
13706정성태8/5/20244041개발 환경 구성: 718. Hyper-V - 리눅스 VM에 새로운 디스크 추가
13705정성태8/4/20244017닷넷: 2291. C# 13 - (5) params 인자 타입으로 컬렉션 허용파일 다운로드1
13704정성태8/2/20243763닷넷: 2290. C# - 간이 dotnet-dump 프로그램 만들기파일 다운로드1
13703정성태8/1/20243981닷넷: 2289. "dotnet-dump ps" 명령어가 닷넷 프로세스를 찾는 방법
13702정성태7/31/20243774닷넷: 2288. Collection 식을 지원하는 사용자 정의 타입을 CollectionBuilder 특성으로 성능 보완파일 다운로드1
13701정성태7/30/20243794닷넷: 2287. C# 13 - (4) Indexer를 이용한 개체 초기화 구문에서 System.Index 연산자 허용파일 다운로드1
13700정성태7/29/20243536디버깅 기술: 200. DLL Export/Import의 Hint 의미
13699정성태7/27/20243678닷넷: 2286. C# 13 - (3) Monitor를 대체할 Lock 타입파일 다운로드1
13698정성태7/27/20243560닷넷: 2285. C# - async 메서드에서의 System.Threading.Lock 잠금 처리파일 다운로드1
13697정성태7/26/20243691닷넷: 2284. C# - async 메서드에서의 lock/Monitor.Enter/Exit 잠금 처리파일 다운로드1
13696정성태7/26/20243481오류 유형: 920. dotnet publish - error NETSDK1047: Assets file '...\obj\project.assets.json' doesn't have a target for '...'
13695정성태7/25/20243200닷넷: 2283. C# - Lock / Wait 상태에서도 STA COM 메서드 호출 처리파일 다운로드1
13694정성태7/25/20243684닷넷: 2282. C# - ASP.NET Core Web App의 Request 용량 상한값 (Kestrel, IIS)
13693정성태7/24/20243250개발 환경 구성: 717. Visual Studio - C# 프로젝트에서 레지스트리에 등록하지 않은 COM 개체 참조 및 사용 방법파일 다운로드1
13692정성태7/24/20243766디버깅 기술: 199. Windbg - 리눅스에서 뜬 닷넷 응용 프로그램 덤프 파일에 포함된 DLL의 Export Directory 탐색
13691정성태7/23/20243444디버깅 기술: 198. Windbg - 스레드의 Win32 Message Queue 정보 조회
13690정성태7/23/20243088오류 유형: 919. Visual C++ 리눅스 프로젝트 - error : ‘u8’ was not declared in this scope
13689정성태7/22/20243529디버깅 기술: 197. Windbg - PE 포맷의 Export Directory 탐색
13688정성태7/21/20243357닷넷: 2281. C# - Lock / Wait 상태에서도 일부 Win32 메시지 처리파일 다운로드1
1  2  3  4  [5]  6  7  8  9  10  11  12  13  14  15  ...