【移动应用开发技术】怎么通过静态分析提高iOS代码质量

【移动应用开发技术】怎么通过静态分析提高iOS代码质量

SwiftLint安装$

brew

install

swiftlintpod

'SwiftLint',

:configurations

=>

['Debug']集成进Xcodeif

which

swiftlint

>/dev/null;

then

swiftlint

else

echo

"warning:

SwiftLint

not

installed,

download

from

/realm/SwiftLint"

fi"${PODS_ROOT}/SwiftLint/swiftlint"运行SwiftLint定制disabled_rules:

#

rule

identifiers

to

exclude

from

running

-

colon

-

trailing_whitespace

-

vertical_whitespace

-

function_body_length

opt_in_rules:

#

some

rules

are

only

opt-in

-

empty_count

#

Find

all

the

available

rules

by

running:

#

swiftlint

rules

included:

#

paths

to

include

during

linting.

`--path`

is

ignored

if

present.

-

Source

excluded:

#

paths

to

ignore

during

linting.

Takes

precedence

over

`included`.

-

Carthage

-

Pods

-

Source/ExcludedFolder

-

Source/ExcludedFile.swift

-

Source/*/ExcludedFile.swift

#

Exclude

files

with

a

wildcard

analyzer_rules:

#

Rules

run

by

`swiftlint

analyze`

(experimental)

-

explicit_self

#

configurable

rules

can

be

customized

from

this

configuration

file

#

binary

rules

can

set

their

severity

level

force_cast:

warning

#

implicitly

force_try:

severity:

warning

#

explicitly

#

rules

that

have

both

warning

and

error

levels,

can

set

just

the

warning

level

#

implicitly

line_length:

110

#

they

can

set

both

implicitly

with

an

array

type_body_length:

-

300

#

warning

-

400

#

error

#

or

they

can

set

both

explicitly

file_length:

warning:

500

error:

1200

#

naming

rules

can

set

warnings/errors

for

min_length

and

max_length

#

additionally

they

can

set

excluded

names

type_name:

min_length:

4

#

only

warning

max_length:

#

warning

and

error

warning:

40

error:

50

excluded:

iPhone

#

excluded

via

string

allowed_symbols:

["_"]

#

these

are

allowed

in

type

names

identifier_name:

min_length:

#

only

min_length

error:

4

#

only

error

excluded:

#

excluded

via

string

array

-

id

-

URL

-

GlobalAPIKey

reporter:

"xcode"

#

reporter

type

(xcode,

json,

csv,

checkstyle,

junit,

html,

emoji,

sonarqube,

markdown)!

Function

Body

Length

Violation:

Function

body

should

span

40

lines

or

less

excluding

comments

and

whitespace:

currently

spans

43

lines

(function_body_length)生成报告#

reporter

type

(xcode,

json,

csv,

checkstyle,

junit,

html,

emoji,

sonarqube,

markdown)

$

swiftlint

lint

--reporter

html

>

swiftlint.htmlxcodebuild#

不带pod的项目，target名为TargetName，在Debug下，指定模拟器sdk环境进行编译

xcodebuild

-target

TargetName

-configuration

Debug

-sdk

iphonesimulator

#

带pod的项目，workspace名为TargetName.xcworkspace，在Release下，scheme为TargetName，指定真机环境进行编译。不指定模拟器环境会验证证书

xcodebuild

-workspace

WorkspaceName.xcworkspace

-scheme

SchemeName

Release

#

清楚项目的编译产物

xcodebuild

-workspace

WorkspaceName.xcworkspace

-scheme

SchemeName

Release

clean之后对xcodebuild命令的使用都需要将这些参数替换为自己项目的参数。Infer安装及使用$

brew

install

infer$

cd

projectDir

#

跳过对Pods的分析

$

infer

run

--skip-analysis-in-path

Pods

--

xcodebuild

-workspace

"Project.xcworkspace"

-scheme

"Scheme"

-configuration

Debug

-sdk

iphonesimulator$

infer

explore

--html$

xcodebuild

-workspace

"Project.xcworkspace"

-scheme

"Scheme"

-configuration

Debug

-sdk

iphonesimulator

clean$

infer

run

--skip-analysis-in-path

Pods

--

xcodebuild

-workspace

"Project.xcworkspace"

-scheme

"Scheme"

-configuration

Debug

-sdk

iphonesimulatorInfer的大致原理1、捕获阶段2、分析阶段OCLint$

brew

tap

oclint/formulae

$

brew

install

oclint$

oclint

--version

LLVM

(/):

LLVM

version

5.0.0svn-r313528

Optimized

build.

Default

target:

x86_64-apple-darwin19.0.0

Host

CPU:

skylake

OCLint

(/):

OCLint

version

0.13.

Built

Sep

18

2017

(08:58:40).1

error

generated

1

error

generated

...

oclint:

error:

cannot

open

report

output

file

/onlintReport.html编译OCLint$

brew

install

cmake

ninja$

git

clone

/oclint/oclint$

./make设置oclint工具的环境变量OCLint_PATH=/Users/zhangferry/oclint/build/oclint-release

export

PATH=$OCLint_PATH/bin:$PATH$

oclint

--version

OCLint

(/):

OCLint

version

0.15.

Built

May

19

2020

(11:48:49).安装xcpretty$

gem

install

xcprettyOCLint的使用post_install

do

|installer|

installer.pods_project.targets.each

do

|target|

target.build_configurations.each

do

|config|

config.build_settings['COMPILER_INDEX_STORE_ENABLE']

=

"NO"

end

end

end$

xcodebuild

-workspace

ProjectName.xcworkspace

-scheme

ProjectScheme

-configuration

Debug

-sdk

iphonesimulator

|

xcpretty

-r

json-compilation-database

-o

compile_commands.json$

oclint-json-compilation-database

-e

Pods

--

-report-type

html

-o

oclintReport.html

-rc

LONG_LINE=9999

-max-priority-1=9999

-max-priority-2=9999

-max-priority-3=9999封装脚本#!/bin/bash

#

mark

sure

you

had

install

the

oclint

and

xcpretty

#

You

need

to

replace

these

values

with

your

own

project

configuration

workspace_name="WorkSpaceName.xcworkspace"

scheme_name="SchemeName"

#

remove

history

rm

compile_commands.json

rm

oclint_result.xml

#

clean

project

#

-sdk

iphonesimulator

means

run

simulator

xcodebuild

-workspace

$workspace_name

-scheme

$scheme_name

-configuration

Debug

-sdk

iphonesimulator

clean

||

(echo

"command

failed";

exit

1);

#

export

compile_commands.json

xcodebuild

-workspace

$workspace_name

-scheme

$scheme_name

-configuration

Debug

-sdk

iphonesimulator

\

|

xcpretty

-r

json-compilation-database

-o

compile_commands.json

\

||

(echo

"command

failed";

exit

1);

#

export

report

html

#

you

can

run

`oclint

-help`

to

see

all

USAGE

oclint-json-compilation-database

-e

Pods

--

-report-type

html

-o

oclintReport.html

\

-disable-rule

ShortVariableName

\

-rc

LONG_LINE=1000

\

||

(echo

"command

failed";

exit

1