jungho-git/xml

XML

• Shared examples and formatting reference: references/EXAMPLE.md.
• Keep new guidance, snippets, and edits aligned with that file.

Scope

Use this rule when:

• editing .xml files
• changing Maven, Spring, MyBatis, log4j, logback, or other XML config
• editing embedded SQL inside mapper XML
• changing namespace declarations, schema references, attributes, or nodes

XML edits should preserve schema, namespace, and framework contracts.

Core Rules

• Preserve namespace declarations and xsi:schemaLocation unless intentionally changing them.
• Match existing indentation; use 2 spaces when no local pattern exists.
• Do not self-close elements whose content model expects children.
• Use attributes for identity or metadata and child elements for structured content.
• Preserve CDATA unless changing literal content requires it.
• Validate well-formedness after structural edits.

MyBatis Contract

• Treat mapper interface and XML as one contract.
• Keep namespace, statement id, parameterType, resultType, and resultMap aligned.
• Preserve aliases and resultMap behavior callers depend on.
• Review <if>, <choose>, and <foreach> branches for null, empty, and optional input.
• Do not create <sql> snippets unless requested or genuinely repeated clauses require them.

Layering

• Mapper XML is for retrieval and persistence.
• Business logic belongs in Java or application code.
• Do not move format conversion, string manipulation, calculations, or code mapping into mapper XML queries.

Formatting

• Use one attribute per line when an element has more than two attributes.
• Put closing tags on their own line for block children.
• Use exactly one space around binary operators inside embedded SQL and OGNL expressions.
• Never vertically align attributes or embedded expressions.
• Keep compact standard style.

Validation Focus

• namespace correctness
• mapper method name vs statement id
• parameter and result shape
• embedded SQL parameter binding
• dynamic branch behavior
• well-formedness and schema/DTD validation when available