Escape رشته JSON

Escape رشته JSON چیست؟

Escape رشته JSON فرآیند تبدیل کاراکترهای خاص درون یک رشته به دنباله‌های escape است که تجزیه‌کننده‌های JSON می‌توانند بدون شکستن ساختار آن‌ها را بخوانند. مشخصات JSON (ECMA-404 / RFC 8259) الزام می‌کند که برخی کاراکترها درون مقادیر رشته‌ای با یک بک‌اسلش شروع شوند. بدون escape مناسب، یک دوتاقول واقعی یا خط جدید درون یک رشته، آن را زودتر از موعد پایان می‌دهد و خطای تجزیه ایجاد می‌کند.

هر رشته JSON با دوتاقول محصور می‌شود. وقتی رشته خودش حاوی دوتاقول، بک‌اسلش، یا یک کاراکتر کنترلی (U+0000 تا U+001F) باشد، باید با دنباله escape جایگزین شود. برای مثال، یک خط جدید واقعی به \n تبدیل می‌شود، تب به \t، و دوتاقول به \". هر نقطه کد یونیکد را می‌توان به صورت \uXXXX نمایش داد که XXXX مقدار هگزادسیمال چهاررقمی است.

Unescape (عملیات معکوس) آن دنباله‌های بک‌اسلش را به کاراکترهای اصلی تبدیل می‌کند. از آن استفاده کنید وقتی پیلود JSON دریافت می‌کنید که مقادیر رشته‌ای آن دوبار escape شده‌اند، یا وقتی می‌خواهید متن خام را از یک ورودی لاگ JSON برای نمایش در رابط کاربری یا ترمینال استخراج کنید. پایپلاین‌های تجمیع لاگ دائماً با این مشکل مواجه می‌شوند: وقتی یک پیام JSON-encoded به عنوان مقدار رشته‌ای درون یک سند JSON دیگری ذخیره می‌شود، هر بک‌اسلش در رشته داخلی دوتایی می‌شود.

چرا از ابزار JSON Escape استفاده کنیم؟

افزودن یا حذف دستی بک‌اسلش‌ها خسته‌کننده و مستعد خطاست، به‌خصوص هنگام کار با متن چندخطی، مسیرهای فایل، یا قطعه‌کدهای تعبیه‌شده. یک ابزار تخصصی escape موارد حاشیه‌ای را که ویرایش دستی نادیده می‌گیرد شناسایی می‌کند.

موارد استفاده JSON String Escape

مرجع دنباله‌های Escape JSON

مشخصات JSON دقیقاً دو escape اجباری (دوتاقول و بک‌اسلش) و شش دنباله escape کوتاه برای کاراکترهای کنترلی رایج تعریف می‌کند. تمام کاراکترهای کنترلی دیگر (U+0000 تا U+001F) باید از فرم \uXXXX استفاده کنند. کاراکترهای بالاتر از U+FFFF (مانند ایموجی) می‌توانند به صورت یک جفت surrogate UTF-16 نمایش داده شوند: \uD83D\uDE00.

تفاوت JSON Escaping و JSON Encoding

توسعه‌دهندگان گاهی escape کردن یک رشته را با encoding یک سند JSON کامل اشتباه می‌گیرند.

نمونه‌های کد

هر زبان اصلی توابع داخلی برای این کار دارد. نمونه‌ها در JavaScript، Python، Go، و jq:

// JSON.stringify escapes a value and wraps it in quotes
JSON.stringify('Line 1\nLine 2')       // → '"Line 1\\nLine 2"'

// To get just the inner escaped string (no surrounding quotes):
const escaped = JSON.stringify('She said "hello"').slice(1, -1)
// → 'She said \\"hello\\"'

// Parsing reverses the escaping
JSON.parse('"tabs\\tand\\nnewlines"')  // → 'tabs\tand\nnewlines'

// Handling Unicode: emoji in JSON
JSON.stringify('Price: 5\u20ac')       // → '"Price: 5\u20ac"' (raw euro sign)

import json

# json.dumps escapes and quotes a string
json.dumps('Line 1\nLine 2')           # → '"Line 1\\nLine 2"'

# Ensure ASCII: replace non-ASCII with \uXXXX sequences
json.dumps('Caf\u00e9', ensure_ascii=True)   # → '"Caf\\u00e9"'

# Keep UTF-8 characters as-is (default in Python 3)
json.dumps('Caf\u00e9', ensure_ascii=False)  # → '"Caf\u00e9"'

# Unescape by round-tripping through json.loads
json.loads('"She said \\"hello\\""')      # → 'She said "hello"'

package main

import (
	"encoding/json"
	"fmt"
)

func main() {
	// json.Marshal escapes a Go string for JSON
	raw := "Line 1\nLine 2\tindented"
	b, _ := json.Marshal(raw)
	fmt.Println(string(b))
	// → "Line 1\nLine 2\tindented"

	// Unescape with json.Unmarshal
	var out string
	json.Unmarshal([]byte(`"She said \"hello\""`), &out)
	fmt.Println(out)
	// → She said "hello"
}

# Escape a raw string into a JSON-safe value
echo 'Line 1
Line 2	with tab' | jq -Rs '.'
# → "Line 1\nLine 2\twith tab\n"

# Unescape a JSON string back to raw text
echo '"She said \"hello\""' | jq -r '.'
# → She said "hello"

سوالات متداول