Dosya adı kodlamaları ile ilgili bir gereksinimi ifade etme

Ben bir şartname spec yazma sürecinde ve gereksinimleri bir parça ifade bir ikilem var.

Senaryo: Dosyaları bir web sitesinden indiriyoruz ve indirilen dosyaların sahip olduğumuz CM aracındaki bir öğeye eklenmesi gerekiyor. İndirilen dosyalar ASCII, ISO-8859-1, Japonca vb. Olabilen adlar içerir.

Aşağıdaki ifadede, "ASCII olmayan" tüm durumları kapsıyor mu?

İndirilen dosya adı ASCII olmayan karakterler içerebilir ve bunun işlenmesi, uygulamanın çökmesine neden olmaz

Belirtildiği gibi, gereksinim benim için bulanık.

İlk sorum şu: kaç karakter kodlamasının desteklenmesi gerekiyor? Olası yorumlar şunları içerir:

1. Tek bayt (örn. ISO-8859-15 ), çoklu bayt (örneğin Big5 , Shift-JIS , HZ ) ve nadir / garip kodlar (örneğin UTF-7 , Punycode , EBCDIC ) dahil olmak üzere şimdiye kadar geliştirilen her kodlama .
2. Açıkçası aşırı. Sadece asgari desteğe, yani ISO-8859-1'e ne dersiniz ?
3. Sadece ISO-8859-1 zayıf görünüyor. Modern en iyi uygulamaları, yani Unicode'u UTF-8 olarak desteklemeye ne dersiniz ?

Hangi kodlamaları kastettiğinizi belirtmezseniz, kodlamaya özgü bir hata oluştuğunda, siz ve uygulayıcı kavga edebilir ve her ikisi de haklı olabilirsiniz. Bu, tanım gereği, bulanık bir spesifikasyonun sonucudur.

Dahası, yazılımın çökmekten başka dosya adıyla ne yapması gerekiyor? Gerekirse…

4. Dosya adını orijinal kodlaması olan bayt bayt olarak saklansın mı?
5. Her şey Unicode için normalleştirilsin mi? Öyleyse, kaynak kodlamasını otomatik olarak algılaması gerekiyor mu? Hangi mekanizma ile?
6. Normalleştirmenin başarısız olması durumunda Unicode formunu ve orijinali saklayın.

İhtiyacınızın daha iyi bir versiyonu

İndirici en az ASCII, ISO-8859-1, ISO-8859-15, KOI8-R, UTF-8, Shift-JIS, EUC-JP, GB2312 ve Big5 dahil olmak üzere çeşitli kodlamalarda dosya adlarını desteklemelidir. Web sunucusu yanıtı bir kodlama belirtiyorsa, buna uyulması gerekir. (Kodlama belirtilmezse, ISO-8859-1 varsayılabilir veya daha iyi bir tahmin yapılabilir.) Dosya adları, içerik yönetim sistemindeki Unicode temsiline normalleştirilecektir.

Gerekli kodlamaların spesifik örnekleri kabul kriterlerinin oluşturulması için gereklidir. Eklenen cümleler yazılımın ne yapması gerektiğini, çökmekten öte olduğunu belirtir.

Yazdığınız gereklilik iyi bir gereksinimin özelliklerine sahip değil . Özellikle, yapışkan değildir, atomik değildir ve açık değildir. Bu özelliklerin eksikliği nedeniyle, aynı zamanda kolayca doğrulanamaz.

İlk eyalet gereksiniminiz:

İndirilen dosya adı ASCII olmayan karakterler içerebilir ve bunun işlenmesi, uygulamanın çökmesine neden olmaz

"... ve bunun işlenmesi uygulama çökmez" kaldırılmasını öneriyoruz. Bir yazılım parçasının bir şey yapması gerektiğine dair bir gereksiniminiz varsa, yazılımı çökmeden yapması gerektiğini varsaymanın doğru olduğunu düşünüyorum.

Bu gereksinimi şuna dönüştürür:

İndirilen dosya adı ASCII olmayan karakterler içerebilir

Şimdi, uyumlu ve atomik bir gereksiniminiz var. Ancak, bunun açık olduğundan emin değilim. Sorunuzda bir dizi farklı formattan bahsediyorsunuz. Birkaç seçenek var.

Bazıları, desteklenmesi gereken her dosya adı kodlaması için ayrı ve benzersiz bir gereksinim önerir. Bu en iyi şekilde uyumlu, atomik, izlenebilir, açık ve doğrulanabilir gereksinimleri destekleyecektir. Ayrıca her gereksinimin önemini belirtmeyi kolaylaştırabilir - belki de bazı kodlamalar için destek daha önemlidir veya daha erken ihtiyaç duyulur.

Diğerleri desteklenen biçimlerden oluşan bir tablo önerebilir ve bu gereksinim bir tabloya bağlanır. Daha az eksiksiz olurdu (metinsel bir cümleniz ve korunacak bir tablonuz var), ancak aynı belge veya veritabanında olacaklardı. Ancak, bir gereksinim yönetimi aracında bağlantı gerçekleştirecekseniz, bunlara yapılan değişiklikler bağlantılı gereksinimi vurgulayacak şekilde birbirine bağlanabilir. Ayrıca, metnin diğer yazılım paketlerine olduğu gibi, ancak farklı kodlamalar için farklı bir tabloyla akmasına izin verir.

Gereksinimleri nasıl belgelediğiniz özel gereksinimlerinize bağlıdır.

İfadenizle ilgili gereksinimi zayıflatan birkaç sorun vardır:

1) gerekliliğini ifade etmelidir olumlu ziyade gerektiğini açısından daha terimlerin yapamaz . Biri nasıl "çökmüyor" diye test eder.

2) ifadesi "indirilen dosya adı olabilir içeriyor ..." belirsiz.

Önerilen alternatif ifadeler (tamamen öznel) elbette şunlar olabilir:

Uygulama, ASCII olmayan karakterler içeren indirilen dosya adlarını destekleyecektir.

("Destek" kelimesi hala biraz belirsiz ve başvurunuzla ilgili diğer gereksinimlerle birlikte kullanıldığında daha somut olarak değiştirilebilir.)

Yazılan spec ile ilgili sorun, uygulamanın "ilginç" dosya adlarıyla ne yapması gerektiğini söylememesi. Ben onunla anlamadı herhangi bir dosya adı karakterleri yerini alacak bir programı karşılaştığınız _etkisiyle, yani ikinci dosya isimleri karakterler haricinde aynıydı yarar anlamadı iki karakter içeren bir dizin kopyalamak için sorulduğunda dizine yazılan ilk kodun üzerine yazılır. Bu tür davranışlar "çökmeme" olarak nitelendirilir, ancak açık bir spesifikasyonun olmadığı kabul edilebilir olduğu anlamına gelmez.

İyi bir spesifikasyonun ne olması gerektiğini açıkça belirtmesi gerektiğini veya başka eylem biçimlerinin kabul edilebilir olduğunu, örneğin "Bir dosya adı tanınmayan karakterler içeriyorsa, sistem genel işlem için yeni bir GUID oluşturmalı ve bir dosya adı oluşturmalıdır. bu GUID, bir dizin numarası ve orijinal dosya adının kolayca yerleştirilebilecek herhangi bir bölümünü birleştirir; eski ve yeni dosya adlarını eşleyen bir tablo oluşturmalıdır "veya" Bir dosya adı tanınmayan karakterler içeriyorsa, sistem yeni bir tanıdığı karakterleri birleştirerek, iki dosya adı bu dönüşümle özdeşleşirse, ikisinden biri keyfi olarak 'kazanan' olarak ilan edilebilir ".