- Форматирование чисел в Android-приложении: уроки программирования
- Android stylish String: форматирование текста в стиле HTML.
- Курсив, подчеркнутый, жирный, зачеркнутый и другие виды форматирования
- С-style строки в ресурсах
- Заключение
- Советы по чистому коду новичкам в Java/Android
- Общие советы
- Наименование
- Функции
- Форматирование
- Классы
- Советы о разном
Форматирование чисел в Android-приложении: уроки программирования
Проблема
Вам нужно форматировать номера, потому что форматирование по умолчанию с помощью Double.toString() и подобных функций не дает вам достаточного контроля над тем, как отображаются результаты.
Решение
Используйте функцию String.format() или один из подклассов класса NumberFormat .
Обсуждение
Функция printf() была впервые включена в язык программирования С в 1970- х гг. и использовалась на многих других языках, включая Java. Вот простой пример printf() в версии Java SE:
В предыдущем примере можно было бы напечатать что-то вроде этого:
Поскольку мы не используем System.out на платформе Android, вам будет приятно заметить, что вы можете получить ту же строку, которая будет напечатана, для того, чтобы поместить ее в представление, используя:
Если раньше вы не видели функцию printf() , то первым аргументом, очевидно, является строка кода формата, а любые другие аргументы (имя пользователя и время) являются значениями, которые нужно форматировать. Коды формата начинаются со знака процента ( % ) и имеют хотя бы один код для элементарных типов.
В табл. 1 приведены некоторые коды для элементарных типов.
Таблица 1. Некоторые коды для форматирования элементарных типов
Символ
Значение
Строка (конвертировать элементарные значения с использованием значений по умолчанию, конвертировать объекты с помощью функции toString )
Десятичное целое число (int, long)
Число с плавающей точкой (float, double)
Форматы времени/даты, специфичные для Java; См. в конце статьи
Форматирование даты по умолчанию довольно уродливое, поэтому нам часто нужно расширять его. Возможности форматирования printf() на самом деле размещены в классе java.util.Formatter , на который должна быть сделана ссылка.
В отличие от функции printf() на других языках, которые вы, возможно, использовали, все эти форматные процедуры необязательно позволяют ссылаться на аргументы по их числу, помещая число плюс знак доллара после ввода знака % , но до собственно кода форматирования. Например, %2$3.1f означает форматирование второго аргумента как десятичного числа с тремя символами и одной цифрой после десятичной точки. Эта нумерация может использоваться для двух целей: изменить порядок, в котором выводятся аргументы (часто полезны с интернационализацией), и ссылаться на данный аргумент более одного раза. Формат даты/времени t требует после него второго символа, такого как Y для года, m для месяца и т. д. Здесь мы берем аргумент time и извлекаем из него несколько полей:
Это выдаст: July 4, 2010 .
Для того чтобы печатать номера с определенной точностью, вы можете использовать параметр f , задав ширину и точность, например:
Результат может выглядеть так:
Хотя такое форматирование подходит для конкретных целей, таких как широта и долгота, для общего использования (например, для вывода суммы валюты) оно может дать вам слишком большой контроль.
Общие форматы
В языке Java есть целый пакет java.text , который полон процедур форматирования как общих и гибких, так и всех, что вы можете себе представить. Как и в функции printf() , в нем используется язык форматирования, описанный на онлайн-странице документации. Рассмотрим представление чисел. В Северной Америке число “одна тысяча двадцать четыре и четверть” имеет вид 1, 024.25; в большинстве стран Европы — 1 024,25, а в некоторых других странах это может быть написано как 1.024, 25. Форматирование валют и процентов также отличается большим разнообразием. Попытка отслеживать это сама по себе быстро переутомила бы среднего разработчика программного обеспечения.
К счастью, пакет java.text включает класс Locale . Кроме того, среда выполнения Java или Android автоматически устанавливает объект класса Locale по умолчанию на основе среды пользователя; этот код работает как на настольных компьютерах в среде Java, так и на устройствах Android. Чтобы обеспечить форматирование, настроенное для чисел, валют и процентов, класс NumberFormat имеет статические встроенные методы, которые обычно возвращают объект класса Decimal Format с уже созданным шаблоном. Объект класса Decimal Format, соответствующий локализации пользователя, может быть получен с помощью встроенного метода NumberFormat.getlnstance() и управляться с использованием set-методов. Удивительно, но метод setMinimumlntegerDigits() оказывается простым способом создания формата чисел с ведущими нулями. Рассмотрим пример.
Пример 2. Пример форматирования числа
Этот код печатает содержимое массива с помощью экземпляра класса NumberFormat . Мы показываем запуск его как основной программы, а не в приложении для Android, чтобы подчеркнуть эффекты класса NumberFormat .
Например, инструкция $ java NumFormat2 0.0 форматирует нуль как 000.00 ; с аргументом 1.0 она создает представление 001.00 , число 3.142857142857143 она представляет как 003.1429 , а 100.2345678 — как 100.2346 .
Вы также можете создать объект класса DecimalFormat с определенным шаблоном или динамически изменять шаблон с помощью метода applyPattern() . В табл. 2 показаны некоторые из наиболее распространенных шаблонных символов.
Таблица 2. Общие СИМВОЛЫ шаблона DecimalFormat
Символ | Значение |
# | Цифра (подавление ведущих нулей) |
0 | Цифра (указаны ведущие нули) |
. | Локализованный десятичный разделитель (десятичная точка) |
, | Локализованный разделитель групп (запятая на английском языке) |
— | Локализованный минус (знак «минус») |
% | Показывает значение в процентах |
; | Отделяет два формата: первый для положительного значения и второй для отрицательного |
‘ | Выводит предыдущий символ как таковой |
Другие | Появляется без обработки |
Программа NumFormatTest использует один десятичный формат для печати номера с двумя десятичными знаками и второй для форматирования числа в соответствии с языковым стандартом по умолчанию, как показано в примере ниже.
Пример 3. Программа демоверсии NumberFormat Java SE
Эта программа печатает данный шаблон, а затем форматирует один и тот же номер, используя несколько форматов:
Источник
Android stylish String: форматирование текста в стиле HTML.
Сегодня мы займемся стилизацией строк. Отмечу, что существует два подхода: форматирование строки в ресурсах при помощи тегов — простое и часто достойное решение. Второй подход — это форматирование при помощи Span в рантайме,чуть сложнее, но гораздо мощнее. Сегодня рассмотрим первый подход.
Курсив, подчеркнутый, жирный, зачеркнутый и другие виды форматирования
Android позволяет нам использовать многие теги HTML для форматирования текста в ресурсных файлах, все они приведены в таблице ниже.
Тег | Результат применения |
---|---|
жирный текст | |
курсив | |
подчеркнутый текст | |
тест по-больше | |
текст по-меньше | |
текст и подстрочный текст | |
текст и надстрочный текст |
На заметку: точно такие же теги можно использовать при оформлении обычных HTML-документов. Если вам это интересно, то ознакомится с ними можно на сайте W3Schools.
Приведу пример сторки заданной в ресурсном файле strings.xml:
Результат применения вы видели в на изображении в самом верху статьи.
С-style строки в ресурсах
А что если вам нужно подставить аргумент в строку, вытянутую из ресурсов, наподобии String.format(«Some string: %s, some int %d») ? Такая возможность есть.
В таком случае задаем ресурс в виде:
При этом предполагается, место %s займет некий аргумент. Давайте рассмотрим пример. Спроектируем небольшое приложение, интерфейс которого будет иметь вид:
Подстановка аргумента в строку
Разметка рабочей области будет иметь вид:
А инициализироваться виджеты будут так:
Особое внимание на строки:
У метода с переменным числом аргуметов getString() первый аргумент — это id строки в виде R.string.string_name , а все последующие аргументы метода будут использоваться для подстановки.
Заключение
Сегодня мы научились красиво форматировать наш текст и по-новому использовать строки, хранимые в ресурах.
Источник
Советы по чистому коду новичкам в Java/Android
Теме чистого кода на одном только habrahabr посвящено тысячи статей. Никогда бы не подумал, что захочу написать свою. Но после проведения компанией курсов для желающих связать карьеру с разработкой ПО, в частности разрабатывать под Android, мое мнение поменялось.
За основу статьи взяты советы из классики “Роберт К. Мартин: Чистый код”. Отобрал из них те, которые наиболее часто встречались в виде проблем у студентов. Приведенные советы написаны с учетом моего опыта разработки коммерческих Android приложений. Поэтому не ко всем Android-проектам приведенные ниже советы подойдут, я уже не говорю про другие системы.
Советы в основном приводил с примерами кода как НЕ НУЖНО делать. Как ни странно, у большинства студентов были одни и те же ошибки. Все примеры кода были придуманы, любые совпадения с реально существующим кодом случайны.
Общие советы
1. Код должен быть легко читаемым, понятным и очевидным
Программисты большую часть времени тратят на чтение и анализ написанного кода, а не на написание нового. Важно чтобы Ваш код был легко читаемым, понятным и с прогнозируемым поведением. Это позволит коллегам и Вам по прошествии времени затратить минимальное время на понимание того, что делает каждый кусок кода. Понятный код с прогнозируемым поведением позволит уменьшить вероятность ошибки при внесении изменений не автором кода.
2. При написании кода нужно придерживаться Java Code Conventions либо других спецификаций, принятых на проекте командой
Спецификацию можно сравнить с правилами оформления текста книги. Думаю, немногие захотят читать книгу, где каждый абзац отличается шрифтом, размером и цветом текста. Так и с кодом, куда легче читать оформленный в едином стиле код.
Наименование
1. Имена классов, функций, переменных и параметров должны передавать закладываемый в них смысл.
Довольно очевидный совет, но не всегда его придерживаются. Тут, в качестве примера, можно привести оглавление книги: если все главы названы просто «Главами», то понять в чем суть нельзя. Наименования классов, функций должны сообщать об их предназначении без погружения в детали реализации.
Наименования классов MyActivity, CustomView, MyAdapter говорит только об одном, что это не часть Android SDK и все. SecondActivity говорит, что это не часть Android SDK и о наличии в проекте еще одного Activity, но не факт =)
Правильно именовать классы: MainActivity, FoodsActivity, FoodCartActivity, PhoneInputView . MainActivity — очевидно, что основной разводящий экран приложения. FoodsActivity — экран с перечнем продуктов. PhoneInputView — компонент ввода номера телефона.
Следующие названия переменных бесполезны и нарушают правила наименования:
как и параметры конструктора:
2. Название публичного класса и файла должно совпадать.
Есть следующий класс
Название файла при этом оказывается “products_Activity.java”.
Это не правильно. Название публичного класса и java-файла должны совпадать.
3. В наименованиях нужно использовать только буквы латинского алфавита, никаких цифр, символов подчеркивания и дефисов. Исключения составляют наименования из стандартов (ГОСТ, ISO), символы подчеркивания для разделения слов в наименованиях констант.
Примеры выше: m_textview_1 . Часто вместо lastName пишут userName2 , что не правильно.
4. Не нужно использовать строчные “L” и “O” в качестве имен локальных переменных, т.к. их трудно отличить от “1” и “0”.
Надуманный пример, но что-то подобное я встречал в своей практике
В этой функции пузырьковой сортировки есть одна ошибка, сможете за секунды ее найти=)?
Такой код труден для чтения и при написании легко сделать ошибку, которую можно очень долго искать.
5. Не нужно указывать тип в суффиксе имен.
Вместо accountList нужно писать просто accounts . Это позволит в любое время изменить тип переменной без переименования самой переменной.
А еще ужаснее выглядит nameString, ageFloat .
Исключение составляют наследники классов Android SDK: Activity, Fragment, View, Uri и т.д. По названию NewsSynsService сразу понятно, что класс является «сервисом» и ответственен за синхронизацию новостей. Использование суффикса view в nameView, photoView позволяет легко отличить переменные, относящиеся к верстки, от остальных. Имена view обычно начинают с существительного. Но имена кнопок лучше начинать с глагола: buyButton
6. Имена могут и должны содержать термины из математики, названия алгоритмов, паттернов проектирования и т.д.
Увидев имя BitmapFactory , не автор кода сразу поймет смысл этого класса.
7. Не нужно указывать никакие префиксы при именовании.
Вместо m_user, mUser просто пишется user . Указывать префикс s для статических полей в современных IDE излишне.
Исходники Android SDK не являются здесь показателем в силу давности создания первых версий и наследования кодовой базы до наших дней.
s_ ни к чему в начале названия статического поля. К тому же название констант должно писаться прописными буквами:
8. В наименование классов нужно использовать существительные.
Классы это как объекты реального мира. Поэтому нужно использовать существительные для их названия: AccountsFragment, User, Car, CarModel .
Не нужно называть классы Manager, Processor, Data, Info , т.к. они имеют слишком общее значение. Лучше название класса длиной в два-четыре слова, чем просто Data .
9. Названия классов должны начинаться с прописной буквы.
Слова НЕ должны отделяться символом подчеркивания. Нужно следовать нотации CamelCase: GoodsFragment, BaseFragment
10. Используйте одно слово для каждой концепции.
Использование fetch, retrieve, get в одном классе сбивает с толку. Если класс назвали Customer , то имена переменных класса и параметров функций этого типа лучше называть customer , а не user .
Функции
1. Функция должна выполнять только одну “операцию”. Она должна выполнять ее хорошо. И ничего другого она делать не должна.
Под “операцией” следует понимать не одну математическую операцию или вызов другой функции, а действия на одном уровне абстракции. Чтобы определить, что функция выполняет более одной операции, следует попробовать извлечь из нее другую функцию. Если извлечение функции не дает ничего кроме простой перестановки кода, то значит разбивать дальше функцию не имеет смысла
К примеру есть функция setProducts класса ProductsAdapter :
Внутри функции происходит три основных операции: 1) фильтрация newProducts , 2) очистка и вставка новых значений в products , 3) обновление адаптера notifyDataSetChanged .
Фильтрация элементов newProducts должна происходить в другом методе и даже в другом в класса (например в presenter-е). В ProductsAdapter должны прийти уже отфильтрованные данные.
Лучше переделать код следующим образом:
Параметр newProducts содержит уже отфильтрованный список продуктов.
Можно еще строчки java products.clear(); products.addAll(newProducts);
вынести в отдельную функцию, но особого смысла я в этом не вижу. Лучше заменить notifyDataSetChanged на DiffUtil, это позволит обновлять ячейки в списке эффективнее
2. Размер функции должен быть 8-10 строк.
Функция размером в 3 экрана это не функция, это *****. У меня тоже не всегда получается ограничить размер функции 8-10 строками кода, но нужно стремится к этому. Пример по понятным причинам приводить не буду.
Функции большого размера трудно читать, модифицировать и тестировать. Разбив большую функцию на малые, легче будет понять смысл основной функции, так как мелкие детали будут скрыты. Выделяя функции можно увидеть и избавиться от дублирования кода в основной функции.
3. В теле функции все должно быть на одном уровне абстракции.
Вычисление значения локальной переменной errorMessage имеет более низкий уровень абстракции, чем остальной код внутри функции. Поэтому код java «Article » + article.getName() + » is incorrect» лучше вынести в отдельную функцию.
4. Наименовании функции и передаваемых параметров должно сообщать о том, что делает функция
Причиной выделения блока кода в отдельную функцию может являться желание в пояснении, что делает код. Для этого нужно дать подходящее название функции и параметрам функции.
Непонятно по какому полю будет происходить поиск, что передается на вход функции.
Лучше переделать в следующий вид:
Название функции говорит, что происходит поиск Product по полю id . На вход функция принимает не “null” значение. Если Product не найдется, то вернется “null”.
Роберт К. Мартин советует использовать параметры в качестве части названия функции:
Вызов функции может выглядеть так:
На проектах я такой способ не встречал. Лучше данный способ не использовать и писать полностью название:
5. Имена функций должны начинаться с глагола. Лучше длинное имя, чем не содержательное короткое.
Название start не сообщает, что именно стартует функция. Только заглянув в тело становится понятно, что функция открывает Activity.
А должно быть понятно предназначение функции уже по названию.
6. Вместо передачи в аргументы функции флага (boolean) лучше разбить функцию на две функции
Часто этот флаг является причиной увеличение размера функции при ветвлении логики выполнения в зависимости от значения флага. В таких случаях следует подумать о разбиении данной функции на две. Разное поведение функции в зависимости от переданного флага не всегда очевидно.
7. Дублирующий код следует выносить в отдельную функцию.
Код внутри setOnClickListener отличается только стилем. Этот код стоит вынести в отдельный метод:
8. Не передавайте и не возвращайте из функции “null” когда можно вернуть пустой объект.
Это позволит избежать ошибок NullPointerexception и не нужно будет в местах вызова писать проверки на null.
Kotlin поможет отучиться от вредной привычки передавать и возвращать null.)
Форматирование
1. Код в классе должен читаться сверху-вниз как газетная статья в порядке убывания уровня абстракции. Вначале идут публичные функции, затем приватные.
Основная идея совета в том, что при открытии файла программист начинает просматривать его сверху. Если вначале разместить все публичные функции, то легче будет понять основные операции с объектами класса, ответственность класса и где может использоваться. Данный совет подходит, когда проект строится на интерфейсах.
2. Связанные концепции/функции следует размещать рядом, чтобы не было необходимости постоянно перемещаться по файлу вверх-вниз. Если одна функция вызывает другую, то вызываемая функция должна располагаться под вызывающей функцией (если это возможно) и разделяться пустой строкой.
Данный совет может противоречить предыдущему. Выбрав приоритетный совет для команды, стоит придерживаться его на всем проекте.
3. Каждая последовательная группа строк кода должна представлять одну законченную мысль. Мысли отделяются друг от друга в коде с помощью пустых строк, только слишком злоупотреблять пустыми строчками не стоит
Связанная группа строк это как абзацы в статье. Для разделения абзацев используется красная строка или пустая строка. Так и в коде следует разделять разные по смыслу группы строк, используя пустые строки.
4. Переменные экземпляра класса, статические константы должны быть все в начале класса в одном месте.
В начале класса объявляются публичные константы, затем приватные константы и после них идут приватные переменные.
5. Используйте пробелы для повышения читаемости кода
- в математических операциях для отделения символа операции от операндов: int x = a + b;
- отделения параметров функций: private Article createNewArticle(String title, String description)
- передаваемых параметров функции: createNewArticle(title, description)
6. «Магические цифры, строки» должны быть вынесены в константы .
Пожалуй, самый популярный совет, но все равно продолжают его нарушать.
Лишь прочитав постановку задачи я понял, для чего в коде использовалось число “10”. Лучше это число вынести в константу и дать осмысленное имя.
Строки тоже стоит выносить в константы, особенно если используются в более чем одном месте.
Классы
1. Класс должен иметь одну “ответственность”, одну причину для изменения.
К примеру, наследники класса RecyclerView.Adapter должны отвечать за создание и связывание View с данным. В нем не должен находится код сортировки/фильтрации списка элементов.
Часто в файл с Activity добавляют класс RecyclerView.Adapter, что является не правильным.
2. Не нужны пустые методы или просто вызывающий метод из родительского класса
3. Если переопределяете какой-то метод без вызова метода родительского, то проверьте, что так можно делать.
Загляните в исходники родительских классов, документации. Переопределяемые методы жизненного цикла Activity, Fragment, View должны обязательно должны вызывать методы родительского класса.
Есть аннотация @CallSuper , предупреждающая о необходимости вызывать родительский метод при переопределении.
Советы о разном
1. Используйте средства Android Studio для улучшение качества Вашего кода.
Если она подчеркивает или выделяет код, значит что-то может быть не так. В Android Studio есть средства Rearrange, Reformat, Extract Method, Inline Method, анализаторы кода, горячие клавиши и т.д.
2. Не нужно комментировать каждый метод, код должен быть самодокументированным.
Следует отметить, что комментарии должны пояснять намерения и причины, а не поведение кода. Создавая комментарий, необходимо брать на себя ответственность о поддержании комментария в актуальном состоянии.
3. Строки, цвета, размеры должны быть в ресурсах (xml)
Не нужно писать:
Исключения составляют файлы из папок test, mock. Такие файлы не должны попадать в релизную версию
4. Не нужно передавать context в RecyclerView.Adapter. context можно получить из любой view. Элемент по клику в RecyclerView.Adapter должен меняться через notifyItemChanged, а не непосредственным изменением вьюшек в методе обработки нажатия
В методе onClick непосредственно происходит вызов bindViewHolder , что НЕ правильно.
5. В RecyclerView.ViewHolder вместо определения позиции объекта в списке нужно вызывать getAdapterPosition, а не передавать position из метода onBindViewHolder
Правильно писать:
Либо можно вместо позиции передавать ссылку на исходный объект с данными
6. Используйте Quantity Strings (Plurals) для множественного числа. Вместо написания в коде логики по подбору правильного окончания слов.
7. Не сохраняйте большие данные Bitmap в bundle. Размер bundle ограничен
8. Если прописать “id” в xml, то Android сам восстановит состояние стандартных View при повороте.
Источник